From 9bf02bc0ac058db14734d2ab7c8c23aa6018965a Mon Sep 17 00:00:00 2001 From: Derek Date: Wed, 14 Aug 2019 22:15:54 +0200 Subject: [PATCH 1/3] fix: consistent parameter/response structure --- lib/endpoint/find-parameters.js | 46 +++++++++---------- .../overrides/map-parameters-to-input.js | 20 ++++---- 2 files changed, 31 insertions(+), 35 deletions(-) diff --git a/lib/endpoint/find-parameters.js b/lib/endpoint/find-parameters.js index 52e9c013f2..22a36c1e32 100644 --- a/lib/endpoint/find-parameters.js +++ b/lib/endpoint/find-parameters.js @@ -5,23 +5,21 @@ const _ = require('lodash') const PAGINATION_VARIABLES = [ { name: 'per_page', + description: 'Results per page (max 100)', in: 'query', schema: { type: 'integer', default: 30 - }, - required: false, - description: 'Results per page (max 100)' + } }, { name: 'page', + description: 'Page number of the results to fetch.', in: 'query', schema: { type: 'integer', default: 1 - }, - required: false, - description: 'Page number of the results to fetch.' + } } ] @@ -40,7 +38,7 @@ function findParameters (state) { name: 'labels', type: 'string', required: true, - description: '', + description: 'labels parameter', location: 'body' } Object.assign(PARAMETERS_TO_INPUT, { @@ -92,12 +90,12 @@ function findInRoutePath (state) { pathParameters.push({ name, + description: `${name} parameter`, in: 'path', + required: true, schema: { type: getRoutePathParameterType(name) - }, - required: true, - description: `${name} parameter` + } }) }) @@ -193,32 +191,32 @@ function findInBlocks (state) { params.push({ name: 'committer', + description: 'object containing information about the committer.', in: getParameterLocation({ method, path, parameter: { name: 'commiter' } }), schema: { - description: 'object containing information about the committer.', type: 'object', + description: 'object containing information about the committer.', properties: {} - }, - description: 'object containing information about the committer.' + } }) params.push({ name: 'author', + description: 'object containing information about the author.', in: getParameterLocation({ method, path, parameter: { name: 'author' } }), schema: { - description: 'object containing information about the author.', type: 'object', + description: 'object containing information about the author.', properties: {} - }, - description: 'object containing information about the author.' + } }) } @@ -399,12 +397,11 @@ function mapToInput (state) { const mapToInputParam = PARAMETERS_TO_INPUT[mapKey] if (mapToInputParam) { - const schema = buildSchema({ ...mapToInputParam }) - delete schema.description - schema.description = `${mapToInputParam.name} parameter` route.operation.requestBody = { content: { - 'application/json': { schema } + 'application/json': { + schema: buildSchema({ ...mapToInputParam }) + } } } route.operation['x-github'].requestBodyParameterName = mapToInputParam.name @@ -428,15 +425,15 @@ function formatParam (param) { delete schemaParam.description } if (location === 'query') { - delete schemaParam.required delete schemaParam.description + delete schemaParam.required } return { name, + description: newDescription, in: location, - schema: buildSchema(schemaParam, operation.parameters), required, - description: newDescription + schema: buildSchema(schemaParam, operation.parameters) } } @@ -451,11 +448,10 @@ function buildSchema (param, params) { } function initSchema (type, param) { - const schema = {} + const schema = { type } if (param.description) { schema.description = param.description } - schema.type = type if (param.enum) { schema.enum = param.enum } diff --git a/lib/endpoint/overrides/map-parameters-to-input.js b/lib/endpoint/overrides/map-parameters-to-input.js index dd0854f239..ed5470998f 100644 --- a/lib/endpoint/overrides/map-parameters-to-input.js +++ b/lib/endpoint/overrides/map-parameters-to-input.js @@ -3,70 +3,70 @@ module.exports = { name: 'data', type: 'string', required: true, - description: '', + description: 'data parameter', location: 'body' }, 'PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts': { name: 'contexts', type: 'string[]', required: true, - description: '', + description: 'contexts parameter', location: 'body' }, 'POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts': { name: 'contexts', type: 'string[]', required: true, - description: '', + description: 'contexts parameter', location: 'body' }, 'DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts': { name: 'contexts', type: 'string[]', required: true, - description: '', + description: 'contexts parameter', location: 'body' }, 'PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams': { name: 'teams', type: 'string[]', required: true, - description: '', + description: 'teams parameter', location: 'body' }, 'POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams': { name: 'teams', type: 'string[]', required: true, - description: '', + description: 'teams parameter', location: 'body' }, 'DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams': { name: 'teams', type: 'string[]', required: true, - description: '', + description: 'teams parameter', location: 'body' }, 'PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users': { name: 'users', type: 'string[]', required: true, - description: '', + description: 'users parameter', location: 'body' }, 'POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users': { name: 'users', type: 'string[]', required: true, - description: '', + description: 'users parameter', location: 'body' }, 'DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users': { name: 'users', type: 'string[]', required: true, - description: '', + description: 'users parameter', location: 'body' } } From 113dd2ea0c8877bee4b05d27e71ae412d1ba877b Mon Sep 17 00:00:00 2001 From: Derek Date: Wed, 14 Aug 2019 22:16:47 +0200 Subject: [PATCH 2/3] fix: consistent parameter/response structure (regenerate docs) --- .../activity/check-starring-repo.json | 12 +- .../activity/check-watching-repo-legacy.json | 12 +- .../activity/delete-repo-subscription.json | 12 +- .../activity/delete-thread-subscription.json | 6 +- .../activity/get-repo-subscription.json | 12 +- .../activity/get-thread-subscription.json | 6 +- .../operations/activity/get-thread.json | 6 +- .../activity/list-events-for-org.json | 22 ++-- .../activity/list-events-for-user.json | 16 +-- .../activity/list-notifications-for-repo.json | 46 ++++--- .../activity/list-notifications.json | 34 +++-- .../activity/list-public-events-for-org.json | 16 +-- .../list-public-events-for-repo-network.json | 22 ++-- .../activity/list-public-events-for-user.json | 16 +-- .../activity/list-public-events.json | 10 +- .../list-received-events-for-user.json | 16 +-- .../list-received-public-events-for-user.json | 16 +-- .../operations/activity/list-repo-events.json | 22 ++-- ...t-repos-starred-by-authenticated-user.json | 22 ++-- .../activity/list-repos-starred-by-user.json | 28 ++-- .../activity/list-repos-watched-by-user.json | 16 +-- .../activity/list-stargazers-for-repo.json | 22 ++-- ...-watched-repos-for-authenticated-user.json | 10 +- .../activity/list-watchers-for-repo.json | 22 ++-- .../operations/activity/mark-as-read.json | 4 +- .../mark-notifications-as-read-for-repo.json | 16 +-- .../activity/mark-thread-as-read.json | 6 +- .../activity/set-repo-subscription.json | 20 +-- .../activity/set-thread-subscription.json | 8 +- .../operations/activity/star-repo.json | 12 +- .../activity/stop-watching-repo-legacy.json | 12 +- .../operations/activity/unstar-repo.json | 12 +- .../activity/watch-repo-legacy.json | 12 +- .../apps/add-repo-to-installation.json | 12 +- ...ccount-is-associated-with-any-stubbed.json | 16 +-- .../check-account-is-associated-with-any.json | 16 +-- .../apps/create-content-attachment.json | 14 +- .../operations/apps/create-from-manifest.json | 6 +- .../apps/create-installation-token.json | 10 +- .../operations/apps/delete-installation.json | 6 +- .../operations/apps/get-by-slug.json | 6 +- .../operations/apps/get-installation.json | 6 +- .../operations/apps/get-org-installation.json | 6 +- .../apps/get-repo-installation.json | 12 +- .../apps/get-user-installation.json | 6 +- ...-accounts-user-or-org-on-plan-stubbed.json | 28 ++-- .../list-accounts-user-or-org-on-plan.json | 28 ++-- ...allation-repos-for-authenticated-user.json | 16 +-- ...-installations-for-authenticated-user.json | 10 +- .../operations/apps/list-installations.json | 10 +- ...chases-for-authenticated-user-stubbed.json | 10 +- ...lace-purchases-for-authenticated-user.json | 10 +- .../operations/apps/list-plans-stubbed.json | 10 +- .../operations/apps/list-plans.json | 10 +- .../operations/apps/list-repos.json | 10 +- .../apps/remove-repo-from-installation.json | 12 +- .../operations/checks/create-suite.json | 16 +-- .../operations/checks/create.json | 118 ++++++++--------- .../operations/checks/get-suite.json | 18 +-- .../api.github.com/operations/checks/get.json | 18 +-- .../operations/checks/list-annotations.json | 28 ++-- .../operations/checks/list-for-ref.json | 46 ++++--- .../operations/checks/list-for-suite.json | 46 ++++--- .../checks/list-suites-for-ref.json | 40 +++--- .../operations/checks/rerequest-suite.json | 18 +-- .../checks/set-suites-preferences.json | 20 +-- .../operations/checks/update.json | 120 +++++++++--------- .../codes-of-conduct/get-conduct-code.json | 6 +- .../codes-of-conduct/get-for-repo.json | 12 +- .../operations/gists/check-is-starred.json | 6 +- .../operations/gists/create-comment.json | 10 +- .../operations/gists/create.json | 12 +- .../operations/gists/delete-comment.json | 12 +- .../operations/gists/delete.json | 6 +- .../api.github.com/operations/gists/fork.json | 6 +- .../operations/gists/get-comment.json | 12 +- .../operations/gists/get-revision.json | 12 +- .../api.github.com/operations/gists/get.json | 6 +- .../operations/gists/list-comments.json | 16 +-- .../operations/gists/list-commits.json | 16 +-- .../operations/gists/list-forks.json | 16 +-- .../gists/list-public-for-user.json | 22 ++-- .../operations/gists/list-public.json | 16 +-- .../operations/gists/list-starred.json | 16 +-- .../api.github.com/operations/gists/list.json | 16 +-- .../api.github.com/operations/gists/star.json | 6 +- .../operations/gists/unstar.json | 6 +- .../operations/gists/update-comment.json | 16 +-- .../operations/gists/update.json | 20 +-- .../operations/git/create-blob.json | 18 +-- .../operations/git/create-commit.json | 54 ++++---- .../operations/git/create-ref.json | 20 +-- .../operations/git/create-tag.json | 40 +++--- .../operations/git/create-tree.json | 34 ++--- .../operations/git/delete-ref.json | 18 +-- .../operations/git/get-blob.json | 18 +-- .../operations/git/get-commit.json | 18 +-- .../operations/git/get-tag.json | 18 +-- .../operations/git/get-tree.json | 26 ++-- .../operations/git/update-ref.json | 24 ++-- .../operations/gitignore/get-template.json | 6 +- .../add-or-update-restrictions-for-org.json | 8 +- .../add-or-update-restrictions-for-repo.json | 14 +- .../get-restrictions-for-org.json | 6 +- .../get-restrictions-for-repo.json | 12 +- .../remove-restrictions-for-org.json | 6 +- .../remove-restrictions-for-repo.json | 12 +- .../operations/issues/add-assignees.json | 20 +-- .../operations/issues/add-labels.json | 20 +-- .../operations/issues/check-assignee.json | 18 +-- .../operations/issues/create-comment.json | 22 ++-- .../operations/issues/create-label.json | 24 ++-- .../operations/issues/create-milestone.json | 26 ++-- .../operations/issues/create.json | 32 ++--- .../operations/issues/delete-comment.json | 18 +-- .../operations/issues/delete-label.json | 18 +-- .../operations/issues/delete-milestone.json | 18 +-- .../operations/issues/get-comment.json | 28 ++-- .../operations/issues/get-event.json | 18 +-- .../operations/issues/get-label.json | 18 +-- .../operations/issues/get-milestone.json | 18 +-- .../api.github.com/operations/issues/get.json | 18 +-- .../operations/issues/list-assignees.json | 22 ++-- .../issues/list-comments-for-repo.json | 30 ++--- .../operations/issues/list-comments.json | 34 +++-- .../issues/list-events-for-repo.json | 22 ++-- .../issues/list-events-for-timeline.json | 28 ++-- .../operations/issues/list-events.json | 28 ++-- .../issues/list-for-authenticated-user.json | 46 ++++--- .../operations/issues/list-for-org.json | 52 ++++---- .../operations/issues/list-for-repo.json | 76 ++++++----- .../issues/list-labels-for-milestone.json | 28 ++-- .../issues/list-labels-for-repo.json | 22 ++-- .../issues/list-labels-on-issue.json | 28 ++-- .../issues/list-milestones-for-repo.json | 40 +++--- .../operations/issues/list.json | 46 ++++--- .../operations/issues/lock.json | 20 +-- .../operations/issues/remove-assignees.json | 20 +-- .../operations/issues/remove-label.json | 24 ++-- .../operations/issues/remove-labels.json | 18 +-- .../operations/issues/replace-labels.json | 20 +-- .../operations/issues/unlock.json | 18 +-- .../operations/issues/update-comment.json | 22 ++-- .../operations/issues/update-milestone.json | 32 ++--- .../operations/issues/update.json | 38 +++--- .../operations/licenses/get-for-repo.json | 12 +- .../operations/licenses/get.json | 6 +- .../operations/markdown/render.json | 10 +- .../operations/migrations/cancel-import.json | 12 +- ...delete-archive-for-authenticated-user.json | 6 +- .../migrations/delete-archive-for-org.json | 12 +- .../get-archive-for-authenticated-user.json | 6 +- .../migrations/get-archive-for-org.json | 12 +- .../migrations/get-commit-authors.json | 18 +-- .../migrations/get-import-progress.json | 12 +- .../migrations/get-large-files.json | 12 +- .../get-status-for-authenticated-user.json | 6 +- .../migrations/get-status-for-org.json | 12 +- .../list-for-authenticated-user.json | 10 +- .../operations/migrations/list-for-org.json | 16 +-- .../migrations/map-commit-author.json | 26 ++-- .../migrations/set-lfs-preference.json | 14 +- .../start-for-authenticated-user.json | 6 +- .../operations/migrations/start-for-org.json | 12 +- .../operations/migrations/start-import.json | 30 ++--- .../unlock-repo-for-authenticated-user.json | 12 +- .../migrations/unlock-repo-for-org.json | 18 +-- .../operations/migrations/update-import.json | 20 +-- .../check-authorization.json | 12 +- .../create-authorization.json | 22 ++-- .../delete-authorization.json | 6 +- .../oauth-authorizations/delete-grant.json | 6 +- .../get-authorization.json | 6 +- .../oauth-authorizations/get-grant.json | 6 +- ...authorization-for-app-and-fingerprint.json | 26 ++-- .../get-or-create-authorization-for-app.json | 24 ++-- .../list-authorizations.json | 10 +- .../oauth-authorizations/list-grants.json | 10 +- .../reset-authorization.json | 12 +- .../revoke-authorization-for-application.json | 12 +- .../revoke-grant-for-application.json | 12 +- .../update-authorization.json | 24 ++-- .../orgs/add-or-update-membership.json | 14 +- .../operations/orgs/block-user.json | 12 +- .../operations/orgs/check-blocked-user.json | 12 +- .../operations/orgs/check-membership.json | 12 +- .../orgs/check-public-membership.json | 12 +- .../operations/orgs/conceal-membership.json | 12 +- ...onvert-member-to-outside-collaborator.json | 12 +- .../operations/orgs/create-hook.json | 32 ++--- .../operations/orgs/create-invitation.json | 18 +-- .../operations/orgs/delete-hook.json | 12 +- .../operations/orgs/get-hook.json | 12 +- ...get-membership-for-authenticated-user.json | 6 +- .../operations/orgs/get-membership.json | 12 +- .../api.github.com/operations/orgs/get.json | 6 +- .../operations/orgs/list-blocked-users.json | 6 +- .../orgs/list-credential-authorizations.json | 6 +- .../orgs/list-for-authenticated-user.json | 10 +- .../operations/orgs/list-for-user.json | 16 +-- .../operations/orgs/list-hooks.json | 16 +-- .../orgs/list-invitation-teams.json | 22 ++-- .../operations/orgs/list-members.json | 28 ++-- .../operations/orgs/list-memberships.json | 16 +-- .../orgs/list-outside-collaborators.json | 22 ++-- .../orgs/list-pending-invitations.json | 16 +-- .../operations/orgs/list-public-members.json | 16 +-- .../api.github.com/operations/orgs/list.json | 16 +-- .../operations/orgs/ping-hook.json | 12 +- .../operations/orgs/publicize-membership.json | 12 +- .../orgs/remove-credential-authorization.json | 12 +- .../operations/orgs/remove-member.json | 12 +- .../operations/orgs/remove-membership.json | 12 +- .../orgs/remove-outside-collaborator.json | 12 +- .../operations/orgs/unblock-user.json | 12 +- .../operations/orgs/update-hook.json | 34 ++--- .../operations/orgs/update-membership.json | 8 +- .../operations/orgs/update.json | 44 +++---- .../operations/projects/add-collaborator.json | 14 +- .../operations/projects/create-card.json | 18 +-- .../operations/projects/create-column.json | 10 +- .../create-for-authenticated-user.json | 18 ++- .../operations/projects/create-for-org.json | 24 ++-- .../operations/projects/create-for-repo.json | 30 ++--- .../operations/projects/delete-card.json | 6 +- .../operations/projects/delete-column.json | 6 +- .../operations/projects/delete.json | 6 +- .../operations/projects/get-card.json | 6 +- .../operations/projects/get-column.json | 6 +- .../operations/projects/get.json | 16 +-- .../operations/projects/list-cards.json | 22 ++-- .../projects/list-collaborators.json | 22 ++-- .../operations/projects/list-columns.json | 16 +-- .../operations/projects/list-for-org.json | 22 ++-- .../operations/projects/list-for-repo.json | 28 ++-- .../operations/projects/list-for-user.json | 22 ++-- .../operations/projects/move-card.json | 12 +- .../operations/projects/move-column.json | 8 +- .../projects/remove-collaborator.json | 12 +- .../review-user-permission-level.json | 12 +- .../operations/projects/update-card.json | 14 +- .../operations/projects/update-column.json | 10 +- .../operations/projects/update.json | 34 +++-- .../operations/pulls/check-if-merged.json | 18 +-- .../pulls/create-comment-reply.json | 26 ++-- .../operations/pulls/create-comment.json | 34 ++--- .../operations/pulls/create-from-issue.json | 32 ++--- .../pulls/create-review-request.json | 22 ++-- .../operations/pulls/create-review.json | 42 +++--- .../operations/pulls/create.json | 36 +++--- .../operations/pulls/delete-comment.json | 18 +-- .../pulls/delete-pending-review.json | 24 ++-- .../pulls/delete-review-request.json | 22 ++-- .../operations/pulls/dismiss-review.json | 28 ++-- .../operations/pulls/get-comment.json | 18 +-- .../pulls/get-comments-for-review.json | 34 +++-- .../operations/pulls/get-review.json | 24 ++-- .../api.github.com/operations/pulls/get.json | 18 +-- .../pulls/list-comments-for-repo.json | 40 +++--- .../operations/pulls/list-comments.json | 46 ++++--- .../operations/pulls/list-commits.json | 28 ++-- .../operations/pulls/list-files.json | 28 ++-- .../pulls/list-review-requests.json | 28 ++-- .../operations/pulls/list-reviews.json | 28 ++-- .../api.github.com/operations/pulls/list.json | 52 ++++---- .../operations/pulls/merge.json | 32 ++--- .../operations/pulls/submit-review.json | 30 ++--- .../operations/pulls/update-branch.json | 22 ++-- .../operations/pulls/update-comment.json | 22 ++-- .../operations/pulls/update-review.json | 28 ++-- .../operations/pulls/update.json | 36 +++--- .../reactions/create-for-commit-comment.json | 20 +-- .../reactions/create-for-issue-comment.json | 20 +-- .../reactions/create-for-issue.json | 20 +-- ...reate-for-pull-request-review-comment.json | 20 +-- .../create-for-team-discussion-comment.json | 20 +-- .../reactions/create-for-team-discussion.json | 14 +- .../operations/reactions/delete.json | 6 +- .../reactions/list-for-commit-comment.json | 34 +++-- .../reactions/list-for-issue-comment.json | 34 +++-- .../operations/reactions/list-for-issue.json | 34 +++-- .../list-for-pull-request-review-comment.json | 34 +++-- .../list-for-team-discussion-comment.json | 34 +++-- .../reactions/list-for-team-discussion.json | 28 ++-- .../operations/repos/accept-invitation.json | 6 +- .../operations/repos/add-collaborator.json | 20 +-- .../operations/repos/add-deploy-key.json | 24 ++-- ...dd-protected-branch-admin-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...dd-protected-branch-team-restrictions.json | 22 ++-- ...dd-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/check-collaborator.json | 18 +-- .../repos/check-vulnerability-alerts.json | 12 +- .../operations/repos/compare-commits.json | 24 ++-- .../repos/create-commit-comment.json | 34 ++--- .../repos/create-deployment-status.json | 34 ++--- .../operations/repos/create-deployment.json | 34 ++--- .../repos/create-for-authenticated-user.json | 42 +++--- .../operations/repos/create-fork.json | 16 +-- .../operations/repos/create-hook.json | 38 +++--- .../operations/repos/create-in-org.json | 48 +++---- .../repos/create-or-update-file.json | 54 ++++---- .../operations/repos/create-release.json | 32 ++--- .../operations/repos/create-status.json | 30 ++--- .../repos/create-using-template.json | 26 ++-- .../operations/repos/decline-invitation.json | 6 +- .../repos/delete-commit-comment.json | 18 +-- .../operations/repos/delete-download.json | 18 +-- .../operations/repos/delete-file.json | 50 ++++---- .../operations/repos/delete-hook.json | 18 +-- .../operations/repos/delete-invitation.json | 18 +-- .../repos/delete-release-asset.json | 18 +-- .../operations/repos/delete-release.json | 18 +-- .../operations/repos/delete.json | 12 +- .../disable-automated-security-fixes.json | 12 +- .../operations/repos/disable-pages-site.json | 12 +- .../repos/disable-vulnerability-alerts.json | 12 +- .../enable-automated-security-fixes.json | 12 +- .../operations/repos/enable-pages-site.json | 20 +-- .../repos/enable-vulnerability-alerts.json | 12 +- .../operations/repos/get-archive-link.json | 24 ++-- .../repos/get-branch-protection.json | 18 +-- .../operations/repos/get-branch.json | 18 +-- .../operations/repos/get-clones.json | 18 +-- .../repos/get-code-frequency-stats.json | 12 +- .../get-collaborator-permission-level.json | 18 +-- .../repos/get-combined-status-for-ref.json | 18 +-- .../repos/get-commit-activity-stats.json | 12 +- .../operations/repos/get-commit-comment.json | 18 +-- .../operations/repos/get-commit.json | 18 +-- .../operations/repos/get-contents.json | 24 ++-- .../repos/get-contributors-stats.json | 12 +- .../operations/repos/get-deploy-key.json | 18 +-- .../repos/get-deployment-status.json | 24 ++-- .../operations/repos/get-deployment.json | 18 +-- .../operations/repos/get-download.json | 18 +-- .../operations/repos/get-hook.json | 18 +-- .../repos/get-latest-pages-build.json | 12 +- .../operations/repos/get-latest-release.json | 12 +- .../operations/repos/get-pages-build.json | 18 +-- .../operations/repos/get-pages.json | 12 +- .../repos/get-participation-stats.json | 12 +- ...et-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...otected-branch-required-status-checks.json | 18 +-- .../get-protected-branch-restrictions.json | 18 +-- .../repos/get-punch-card-stats.json | 12 +- .../operations/repos/get-readme.json | 18 +-- .../operations/repos/get-release-asset.json | 18 +-- .../operations/repos/get-release-by-tag.json | 18 +-- .../operations/repos/get-release.json | 18 +-- .../operations/repos/get-top-paths.json | 12 +- .../operations/repos/get-top-referrers.json | 12 +- .../operations/repos/get-views.json | 18 +-- .../api.github.com/operations/repos/get.json | 12 +- .../repos/list-assets-for-release.json | 28 ++-- .../repos/list-branches-for-head-commit.json | 18 +-- .../operations/repos/list-branches.json | 28 ++-- .../operations/repos/list-collaborators.json | 28 ++-- .../repos/list-comments-for-commit.json | 28 ++-- .../repos/list-commit-comments.json | 22 ++-- .../operations/repos/list-commits.json | 52 ++++---- .../operations/repos/list-contributors.json | 28 ++-- .../operations/repos/list-deploy-keys.json | 22 ++-- .../repos/list-deployment-statuses.json | 28 ++-- .../operations/repos/list-deployments.json | 46 ++++--- .../operations/repos/list-downloads.json | 22 ++-- .../operations/repos/list-for-org.json | 34 +++-- .../operations/repos/list-for-user.json | 34 +++-- .../operations/repos/list-forks.json | 28 ++-- .../operations/repos/list-hooks.json | 22 ++-- ...st-invitations-for-authenticated-user.json | 10 +- .../operations/repos/list-invitations.json | 22 ++-- .../operations/repos/list-languages.json | 12 +- .../operations/repos/list-pages-builds.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 18 +-- ...st-protected-branch-team-restrictions.json | 28 ++-- ...st-protected-branch-user-restrictions.json | 18 +-- .../operations/repos/list-public.json | 16 +-- ...-pull-requests-associated-with-commit.json | 28 ++-- .../operations/repos/list-releases.json | 22 ++-- .../repos/list-statuses-for-ref.json | 28 ++-- .../operations/repos/list-tags.json | 22 ++-- .../operations/repos/list-teams.json | 22 ++-- .../operations/repos/list-topics.json | 12 +- .../api.github.com/operations/repos/list.json | 40 +++--- .../operations/repos/merge.json | 24 ++-- .../operations/repos/ping-hook.json | 18 +-- .../repos/remove-branch-protection.json | 18 +-- .../operations/repos/remove-collaborator.json | 18 +-- .../operations/repos/remove-deploy-key.json | 18 +-- ...ve-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...otected-branch-required-status-checks.json | 18 +-- .../remove-protected-branch-restrictions.json | 18 +-- ...ve-protected-branch-team-restrictions.json | 22 ++-- ...ve-protected-branch-user-restrictions.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...ce-protected-branch-team-restrictions.json | 22 ++-- ...ce-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/replace-topics.json | 14 +- .../operations/repos/request-page-build.json | 12 +- .../retrieve-community-profile-metrics.json | 12 +- .../operations/repos/test-push-hook.json | 18 +-- .../operations/repos/transfer.json | 18 +-- .../repos/update-branch-protection.json | 54 ++++---- .../repos/update-commit-comment.json | 22 ++-- .../operations/repos/update-hook.json | 44 +++---- .../update-information-about-pages-site.json | 18 +-- .../operations/repos/update-invitation.json | 20 +-- ...ranch-pull-request-review-enforcement.json | 36 +++--- ...otected-branch-required-status-checks.json | 24 ++-- .../repos/update-release-asset.json | 26 ++-- .../operations/repos/update-release.json | 42 +++--- .../operations/repos/update.json | 46 +++---- .../get-provisioning-details-for-user.json | 12 +- .../scim/list-provisioned-identities.json | 24 ++-- .../scim/provision-and-invite-users.json | 6 +- .../operations/scim/remove-user-from-org.json | 12 +- .../replace-provisioned-user-information.json | 12 +- .../scim/update-user-attribute.json | 12 +- .../operations/search/code.json | 28 ++-- .../operations/search/commits.json | 28 ++-- .../operations/search/email-legacy.json | 6 +- .../search/issues-and-pull-requests.json | 28 ++-- .../operations/search/issues-legacy.json | 24 ++-- .../operations/search/labels.json | 24 ++-- .../operations/search/repos-legacy.json | 30 ++--- .../operations/search/repos.json | 28 ++-- .../operations/search/topics.json | 6 +- .../operations/search/users-legacy.json | 24 ++-- .../operations/search/users.json | 28 ++-- .../operations/teams/add-member.json | 12 +- .../teams/add-or-update-membership.json | 14 +- .../teams/add-or-update-project.json | 14 +- .../operations/teams/add-or-update-repo.json | 20 +-- .../operations/teams/check-manages-repo.json | 18 +-- .../teams/create-discussion-comment.json | 16 +-- .../operations/teams/create-discussion.json | 16 +-- ...eate-or-update-id-p-group-connections.json | 20 +-- .../operations/teams/create.json | 26 ++-- .../teams/delete-discussion-comment.json | 18 +-- .../operations/teams/delete-discussion.json | 12 +- .../operations/teams/delete.json | 6 +- .../operations/teams/get-by-name.json | 12 +- .../teams/get-discussion-comment.json | 18 +-- .../operations/teams/get-discussion.json | 12 +- .../operations/teams/get-member.json | 12 +- .../operations/teams/get-membership.json | 12 +- .../api.github.com/operations/teams/get.json | 6 +- .../operations/teams/list-child.json | 16 +-- .../teams/list-discussion-comments.json | 28 ++-- .../operations/teams/list-discussions.json | 22 ++-- .../teams/list-for-authenticated-user.json | 10 +- .../teams/list-id-p-groups-for-org.json | 16 +-- .../operations/teams/list-id-p-groups.json | 6 +- .../operations/teams/list-members.json | 22 ++-- .../teams/list-pending-invitations.json | 16 +-- .../operations/teams/list-projects.json | 16 +-- .../operations/teams/list-repos.json | 16 +-- .../api.github.com/operations/teams/list.json | 16 +-- .../operations/teams/remove-member.json | 12 +- .../operations/teams/remove-membership.json | 12 +- .../operations/teams/remove-project.json | 12 +- .../operations/teams/remove-repo.json | 18 +-- .../operations/teams/review-project.json | 12 +- .../teams/update-discussion-comment.json | 22 ++-- .../operations/teams/update-discussion.json | 20 +-- .../operations/teams/update.json | 22 ++-- .../operations/users/add-emails.json | 2 +- .../operations/users/block.json | 6 +- .../operations/users/check-blocked.json | 6 +- .../users/check-following-for-user.json | 12 +- .../operations/users/check-following.json | 6 +- .../operations/users/create-gpg-key.json | 4 +- .../operations/users/create-public-key.json | 8 +- .../operations/users/delete-emails.json | 2 +- .../operations/users/delete-gpg-key.json | 6 +- .../operations/users/delete-public-key.json | 6 +- .../operations/users/follow.json | 6 +- .../operations/users/get-by-username.json | 6 +- .../users/get-context-for-user.json | 18 +-- .../operations/users/get-gpg-key.json | 6 +- .../operations/users/get-public-key.json | 6 +- .../operations/users/list-emails.json | 10 +- ...list-followers-for-authenticated-user.json | 10 +- .../users/list-followers-for-user.json | 16 +-- ...list-following-for-authenticated-user.json | 10 +- .../users/list-following-for-user.json | 16 +-- .../users/list-gpg-keys-for-user.json | 16 +-- .../operations/users/list-gpg-keys.json | 10 +- .../operations/users/list-public-emails.json | 10 +- .../users/list-public-keys-for-user.json | 16 +-- .../operations/users/list-public-keys.json | 10 +- .../api.github.com/operations/users/list.json | 16 +-- .../toggle-primary-email-visibility.json | 8 +- .../operations/users/unblock.json | 6 +- .../operations/users/unfollow.json | 6 +- .../users/update-authenticated.json | 28 ++-- .../activity/check-starring-repo.json | 12 +- .../activity/check-watching-repo-legacy.json | 12 +- .../activity/delete-repo-subscription.json | 12 +- .../activity/delete-thread-subscription.json | 6 +- .../activity/get-repo-subscription.json | 12 +- .../activity/get-thread-subscription.json | 6 +- .../operations/activity/get-thread.json | 6 +- .../activity/list-events-for-org.json | 22 ++-- .../activity/list-events-for-user.json | 16 +-- .../activity/list-notifications-for-repo.json | 46 ++++--- .../activity/list-notifications.json | 34 +++-- .../activity/list-public-events-for-org.json | 16 +-- .../list-public-events-for-repo-network.json | 22 ++-- .../activity/list-public-events-for-user.json | 16 +-- .../activity/list-public-events.json | 10 +- .../list-received-events-for-user.json | 16 +-- .../list-received-public-events-for-user.json | 16 +-- .../operations/activity/list-repo-events.json | 22 ++-- ...t-repos-starred-by-authenticated-user.json | 22 ++-- .../activity/list-repos-starred-by-user.json | 28 ++-- .../activity/list-repos-watched-by-user.json | 16 +-- .../activity/list-stargazers-for-repo.json | 22 ++-- ...-watched-repos-for-authenticated-user.json | 10 +- .../activity/list-watchers-for-repo.json | 22 ++-- .../operations/activity/mark-as-read.json | 4 +- .../mark-notifications-as-read-for-repo.json | 16 +-- .../activity/mark-thread-as-read.json | 6 +- .../activity/set-repo-subscription.json | 20 +-- .../activity/set-thread-subscription.json | 8 +- .../operations/activity/star-repo.json | 12 +- .../activity/stop-watching-repo-legacy.json | 12 +- .../operations/activity/unstar-repo.json | 12 +- .../activity/watch-repo-legacy.json | 12 +- .../apps/add-repo-to-installation.json | 12 +- .../apps/create-installation-token.json | 6 +- .../ghe-2.15/operations/apps/get-by-slug.json | 6 +- .../operations/apps/get-installation.json | 6 +- .../operations/apps/get-org-installation.json | 6 +- .../apps/get-repo-installation.json | 12 +- .../apps/get-user-installation.json | 6 +- ...allation-repos-for-authenticated-user.json | 16 +-- ...-installations-for-authenticated-user.json | 10 +- .../operations/apps/list-installations.json | 10 +- .../ghe-2.15/operations/apps/list-repos.json | 10 +- .../apps/remove-repo-from-installation.json | 12 +- .../operations/checks/create-suite.json | 16 +-- .../ghe-2.15/operations/checks/create.json | 118 ++++++++--------- .../ghe-2.15/operations/checks/get-suite.json | 18 +-- openapi/ghe-2.15/operations/checks/get.json | 18 +-- .../operations/checks/list-annotations.json | 28 ++-- .../operations/checks/list-for-ref.json | 46 ++++--- .../operations/checks/list-for-suite.json | 46 ++++--- .../checks/list-suites-for-ref.json | 40 +++--- .../operations/checks/rerequest-suite.json | 18 +-- .../checks/set-suites-preferences.json | 20 +-- .../ghe-2.15/operations/checks/update.json | 120 +++++++++--------- .../codes-of-conduct/get-conduct-code.json | 6 +- .../codes-of-conduct/get-for-repo.json | 12 +- .../add-authorized-ssh-key.json | 4 +- .../enterprise-admin/create-global-hook.json | 26 ++-- .../create-impersonation-o-auth-token.json | 8 +- .../enterprise-admin/create-org.json | 12 +- .../create-pre-receive-environment.json | 8 +- .../create-pre-receive-hook.json | 20 +-- .../enterprise-admin/create-user.json | 8 +- .../enterprise-admin/delete-global-hook.json | 6 +- .../delete-impersonation-o-auth-token.json | 6 +- .../delete-pre-receive-environment.json | 6 +- .../delete-pre-receive-hook.json | 6 +- .../enterprise-admin/delete-public-key.json | 6 +- .../enterprise-admin/delete-user.json | 6 +- ...e-site-administrator-to-ordinary-user.json | 6 +- .../enable-or-disable-maintenance-mode.json | 4 +- .../enterprise-admin/get-global-hook.json | 6 +- ...e-receive-environment-download-status.json | 24 ++-- .../get-pre-receive-environment.json | 6 +- .../get-pre-receive-hook-for-org.json | 12 +- .../get-pre-receive-hook-for-repo.json | 18 +-- .../get-pre-receive-hook.json | 6 +- .../enterprise-admin/get-type-stats.json | 6 +- .../enterprise-admin/list-global-hooks.json | 10 +- .../list-pre-receive-environments.json | 10 +- .../list-pre-receive-hooks-for-org.json | 16 +-- .../list-pre-receive-hooks-for-repo.json | 22 ++-- .../list-pre-receive-hooks.json | 10 +- .../enterprise-admin/modify-settings.json | 4 +- .../enterprise-admin/ping-global-hook.json | 6 +- ...e-ordinary-user-to-site-administrator.json | 6 +- .../enterprise-admin/queue-indexing-job.json | 4 +- .../remove-authorized-ssh-key.json | 4 +- ...verrides-for-pre-receive-hook-for-org.json | 12 +- ...errides-for-pre-receive-hook-for-repo.json | 18 +-- .../enterprise-admin/rename-org.json | 10 +- .../enterprise-admin/rename-user.json | 10 +- .../enterprise-admin/suspend-user.json | 10 +- .../sync-ldap-mapping-for-team.json | 6 +- .../sync-ldap-mapping-for-user.json | 6 +- ...gger-pre-receive-environment-download.json | 6 +- .../enterprise-admin/unsuspend-user.json | 10 +- .../enterprise-admin/update-global-hook.json | 28 ++-- .../update-ldap-mapping-for-team.json | 10 +- .../update-ldap-mapping-for-user.json | 10 +- .../update-pre-receive-environment.json | 14 +- ...-pre-receive-hook-enforcement-for-org.json | 12 +- ...pre-receive-hook-enforcement-for-repo.json | 18 +-- .../update-pre-receive-hook.json | 6 +- .../enterprise-admin/upgrade-license.json | 4 +- .../upload-license-for-first-time.json | 12 +- .../operations/gists/check-is-starred.json | 6 +- .../operations/gists/create-comment.json | 10 +- openapi/ghe-2.15/operations/gists/create.json | 12 +- .../operations/gists/delete-comment.json | 12 +- openapi/ghe-2.15/operations/gists/delete.json | 6 +- openapi/ghe-2.15/operations/gists/fork.json | 6 +- .../operations/gists/get-comment.json | 12 +- .../operations/gists/get-revision.json | 12 +- openapi/ghe-2.15/operations/gists/get.json | 6 +- .../operations/gists/list-comments.json | 16 +-- .../operations/gists/list-commits.json | 16 +-- .../ghe-2.15/operations/gists/list-forks.json | 16 +-- .../gists/list-public-for-user.json | 22 ++-- .../operations/gists/list-public.json | 16 +-- .../operations/gists/list-starred.json | 16 +-- openapi/ghe-2.15/operations/gists/list.json | 16 +-- openapi/ghe-2.15/operations/gists/star.json | 6 +- openapi/ghe-2.15/operations/gists/unstar.json | 6 +- .../operations/gists/update-comment.json | 16 +-- openapi/ghe-2.15/operations/gists/update.json | 20 +-- .../ghe-2.15/operations/git/create-blob.json | 18 +-- .../operations/git/create-commit.json | 54 ++++---- .../ghe-2.15/operations/git/create-ref.json | 20 +-- .../ghe-2.15/operations/git/create-tag.json | 40 +++--- .../ghe-2.15/operations/git/create-tree.json | 34 ++--- .../ghe-2.15/operations/git/delete-ref.json | 18 +-- openapi/ghe-2.15/operations/git/get-blob.json | 18 +-- .../ghe-2.15/operations/git/get-commit.json | 18 +-- openapi/ghe-2.15/operations/git/get-tag.json | 18 +-- openapi/ghe-2.15/operations/git/get-tree.json | 26 ++-- .../ghe-2.15/operations/git/update-ref.json | 24 ++-- .../operations/gitignore/get-template.json | 6 +- .../operations/issues/add-assignees.json | 20 +-- .../operations/issues/add-labels.json | 18 +-- .../operations/issues/check-assignee.json | 18 +-- .../operations/issues/create-comment.json | 22 ++-- .../operations/issues/create-label.json | 24 ++-- .../operations/issues/create-milestone.json | 26 ++-- .../ghe-2.15/operations/issues/create.json | 32 ++--- .../operations/issues/delete-comment.json | 18 +-- .../operations/issues/delete-label.json | 18 +-- .../operations/issues/delete-milestone.json | 18 +-- .../operations/issues/get-comment.json | 28 ++-- .../ghe-2.15/operations/issues/get-event.json | 18 +-- .../ghe-2.15/operations/issues/get-label.json | 18 +-- .../operations/issues/get-milestone.json | 18 +-- openapi/ghe-2.15/operations/issues/get.json | 18 +-- .../operations/issues/list-assignees.json | 22 ++-- .../issues/list-comments-for-repo.json | 30 ++--- .../operations/issues/list-comments.json | 34 +++-- .../issues/list-events-for-repo.json | 22 ++-- .../issues/list-events-for-timeline.json | 28 ++-- .../operations/issues/list-events.json | 28 ++-- .../issues/list-for-authenticated-user.json | 46 ++++--- .../operations/issues/list-for-org.json | 52 ++++---- .../operations/issues/list-for-repo.json | 76 ++++++----- .../issues/list-labels-for-milestone.json | 28 ++-- .../issues/list-labels-for-repo.json | 22 ++-- .../issues/list-labels-on-issue.json | 28 ++-- .../issues/list-milestones-for-repo.json | 40 +++--- openapi/ghe-2.15/operations/issues/list.json | 46 ++++--- openapi/ghe-2.15/operations/issues/lock.json | 20 +-- .../operations/issues/remove-assignees.json | 20 +-- .../operations/issues/remove-label.json | 24 ++-- .../operations/issues/remove-labels.json | 18 +-- .../operations/issues/replace-labels.json | 18 +-- .../ghe-2.15/operations/issues/unlock.json | 18 +-- .../operations/issues/update-comment.json | 22 ++-- .../operations/issues/update-milestone.json | 32 ++--- .../ghe-2.15/operations/issues/update.json | 38 +++--- .../operations/licenses/get-for-repo.json | 12 +- openapi/ghe-2.15/operations/licenses/get.json | 6 +- .../ghe-2.15/operations/markdown/render.json | 10 +- .../check-authorization.json | 12 +- .../create-authorization.json | 22 ++-- .../delete-authorization.json | 6 +- .../oauth-authorizations/delete-grant.json | 6 +- .../get-authorization.json | 6 +- .../oauth-authorizations/get-grant.json | 6 +- ...authorization-for-app-and-fingerprint.json | 26 ++-- .../get-or-create-authorization-for-app.json | 24 ++-- .../list-authorizations.json | 10 +- .../oauth-authorizations/list-grants.json | 10 +- .../reset-authorization.json | 12 +- .../revoke-authorization-for-application.json | 12 +- .../revoke-grant-for-application.json | 12 +- .../update-authorization.json | 24 ++-- .../orgs/add-or-update-membership.json | 14 +- .../operations/orgs/check-membership.json | 12 +- .../orgs/check-public-membership.json | 12 +- .../operations/orgs/conceal-membership.json | 12 +- ...onvert-member-to-outside-collaborator.json | 12 +- .../ghe-2.15/operations/orgs/create-hook.json | 32 ++--- .../ghe-2.15/operations/orgs/delete-hook.json | 12 +- .../ghe-2.15/operations/orgs/get-hook.json | 12 +- ...get-membership-for-authenticated-user.json | 6 +- .../operations/orgs/get-membership.json | 12 +- openapi/ghe-2.15/operations/orgs/get.json | 6 +- .../orgs/list-for-authenticated-user.json | 10 +- .../operations/orgs/list-for-user.json | 16 +-- .../ghe-2.15/operations/orgs/list-hooks.json | 16 +-- .../operations/orgs/list-members.json | 28 ++-- .../operations/orgs/list-memberships.json | 16 +-- .../orgs/list-outside-collaborators.json | 22 ++-- .../operations/orgs/list-public-members.json | 16 +-- openapi/ghe-2.15/operations/orgs/list.json | 16 +-- .../ghe-2.15/operations/orgs/ping-hook.json | 12 +- .../operations/orgs/publicize-membership.json | 12 +- .../operations/orgs/remove-member.json | 12 +- .../operations/orgs/remove-membership.json | 12 +- .../orgs/remove-outside-collaborator.json | 12 +- .../ghe-2.15/operations/orgs/update-hook.json | 34 ++--- .../operations/orgs/update-membership.json | 8 +- openapi/ghe-2.15/operations/orgs/update.json | 42 +++--- .../operations/projects/add-collaborator.json | 14 +- .../operations/projects/create-card.json | 18 +-- .../operations/projects/create-column.json | 10 +- .../operations/projects/create-for-org.json | 24 ++-- .../operations/projects/create-for-repo.json | 30 ++--- .../operations/projects/delete-card.json | 6 +- .../operations/projects/delete-column.json | 6 +- .../ghe-2.15/operations/projects/delete.json | 6 +- .../operations/projects/get-card.json | 6 +- .../operations/projects/get-column.json | 6 +- openapi/ghe-2.15/operations/projects/get.json | 16 +-- .../operations/projects/list-cards.json | 22 ++-- .../projects/list-collaborators.json | 22 ++-- .../operations/projects/list-columns.json | 16 +-- .../operations/projects/list-for-org.json | 22 ++-- .../operations/projects/list-for-repo.json | 28 ++-- .../operations/projects/move-card.json | 12 +- .../operations/projects/move-column.json | 8 +- .../projects/remove-collaborator.json | 12 +- .../review-user-permission-level.json | 12 +- .../operations/projects/update-card.json | 14 +- .../operations/projects/update-column.json | 10 +- .../ghe-2.15/operations/projects/update.json | 34 +++-- .../operations/pulls/check-if-merged.json | 18 +-- .../pulls/create-comment-reply.json | 26 ++-- .../operations/pulls/create-comment.json | 34 ++--- .../operations/pulls/create-from-issue.json | 28 ++-- .../pulls/create-review-request.json | 22 ++-- .../operations/pulls/create-review.json | 42 +++--- openapi/ghe-2.15/operations/pulls/create.json | 32 ++--- .../operations/pulls/delete-comment.json | 18 +-- .../pulls/delete-pending-review.json | 24 ++-- .../pulls/delete-review-request.json | 22 ++-- .../operations/pulls/dismiss-review.json | 28 ++-- .../operations/pulls/get-comment.json | 18 +-- .../pulls/get-comments-for-review.json | 34 +++-- .../ghe-2.15/operations/pulls/get-review.json | 24 ++-- openapi/ghe-2.15/operations/pulls/get.json | 18 +-- .../pulls/list-comments-for-repo.json | 40 +++--- .../operations/pulls/list-comments.json | 46 ++++--- .../operations/pulls/list-commits.json | 28 ++-- .../ghe-2.15/operations/pulls/list-files.json | 28 ++-- .../pulls/list-review-requests.json | 28 ++-- .../operations/pulls/list-reviews.json | 28 ++-- openapi/ghe-2.15/operations/pulls/list.json | 52 ++++---- openapi/ghe-2.15/operations/pulls/merge.json | 32 ++--- .../operations/pulls/submit-review.json | 30 ++--- .../operations/pulls/update-comment.json | 22 ++-- openapi/ghe-2.15/operations/pulls/update.json | 36 +++--- .../reactions/create-for-commit-comment.json | 20 +-- .../reactions/create-for-issue-comment.json | 20 +-- .../reactions/create-for-issue.json | 20 +-- ...reate-for-pull-request-review-comment.json | 20 +-- .../create-for-team-discussion-comment.json | 20 +-- .../reactions/create-for-team-discussion.json | 14 +- .../ghe-2.15/operations/reactions/delete.json | 6 +- .../reactions/list-for-commit-comment.json | 34 +++-- .../reactions/list-for-issue-comment.json | 34 +++-- .../operations/reactions/list-for-issue.json | 34 +++-- .../list-for-pull-request-review-comment.json | 34 +++-- .../list-for-team-discussion-comment.json | 34 +++-- .../reactions/list-for-team-discussion.json | 28 ++-- .../operations/repos/accept-invitation.json | 6 +- .../operations/repos/add-collaborator.json | 20 +-- .../operations/repos/add-deploy-key.json | 24 ++-- ...dd-protected-branch-admin-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...dd-protected-branch-team-restrictions.json | 22 ++-- ...dd-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/check-collaborator.json | 18 +-- .../operations/repos/compare-commits.json | 24 ++-- .../repos/create-commit-comment.json | 34 ++--- .../repos/create-deployment-status.json | 30 ++--- .../operations/repos/create-deployment.json | 34 ++--- .../repos/create-for-authenticated-user.json | 40 +++--- .../operations/repos/create-fork.json | 16 +-- .../operations/repos/create-hook.json | 36 +++--- .../operations/repos/create-in-org.json | 46 +++---- .../repos/create-or-update-file.json | 54 ++++---- .../operations/repos/create-release.json | 32 ++--- .../operations/repos/create-status.json | 30 ++--- .../operations/repos/decline-invitation.json | 6 +- .../repos/delete-commit-comment.json | 18 +-- .../operations/repos/delete-download.json | 18 +-- .../operations/repos/delete-file.json | 50 ++++---- .../operations/repos/delete-hook.json | 18 +-- .../operations/repos/delete-invitation.json | 18 +-- .../repos/delete-release-asset.json | 18 +-- .../operations/repos/delete-release.json | 18 +-- openapi/ghe-2.15/operations/repos/delete.json | 12 +- .../operations/repos/get-archive-link.json | 24 ++-- .../repos/get-branch-protection.json | 18 +-- .../ghe-2.15/operations/repos/get-branch.json | 18 +-- .../repos/get-code-frequency-stats.json | 12 +- .../get-collaborator-permission-level.json | 18 +-- .../repos/get-combined-status-for-ref.json | 18 +-- .../repos/get-commit-activity-stats.json | 12 +- .../operations/repos/get-commit-comment.json | 18 +-- .../ghe-2.15/operations/repos/get-commit.json | 18 +-- .../operations/repos/get-contents.json | 24 ++-- .../repos/get-contributors-stats.json | 12 +- .../operations/repos/get-deploy-key.json | 18 +-- .../repos/get-deployment-status.json | 24 ++-- .../operations/repos/get-deployment.json | 18 +-- .../operations/repos/get-download.json | 18 +-- .../ghe-2.15/operations/repos/get-hook.json | 18 +-- .../repos/get-latest-pages-build.json | 12 +- .../operations/repos/get-latest-release.json | 12 +- .../operations/repos/get-pages-build.json | 18 +-- .../ghe-2.15/operations/repos/get-pages.json | 12 +- .../repos/get-participation-stats.json | 12 +- ...et-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...otected-branch-required-status-checks.json | 18 +-- .../get-protected-branch-restrictions.json | 18 +-- .../repos/get-punch-card-stats.json | 12 +- .../ghe-2.15/operations/repos/get-readme.json | 18 +-- .../operations/repos/get-release-asset.json | 18 +-- .../operations/repos/get-release-by-tag.json | 18 +-- .../operations/repos/get-release.json | 18 +-- openapi/ghe-2.15/operations/repos/get.json | 12 +- .../repos/list-assets-for-release.json | 28 ++-- .../operations/repos/list-branches.json | 28 ++-- .../operations/repos/list-collaborators.json | 28 ++-- .../repos/list-comments-for-commit.json | 28 ++-- .../repos/list-commit-comments.json | 22 ++-- .../operations/repos/list-commits.json | 52 ++++---- .../operations/repos/list-contributors.json | 28 ++-- .../operations/repos/list-deploy-keys.json | 22 ++-- .../repos/list-deployment-statuses.json | 28 ++-- .../operations/repos/list-deployments.json | 46 ++++--- .../operations/repos/list-downloads.json | 22 ++-- .../operations/repos/list-for-org.json | 22 ++-- .../operations/repos/list-for-user.json | 34 +++-- .../ghe-2.15/operations/repos/list-forks.json | 28 ++-- .../ghe-2.15/operations/repos/list-hooks.json | 22 ++-- ...st-invitations-for-authenticated-user.json | 10 +- .../operations/repos/list-invitations.json | 22 ++-- .../operations/repos/list-languages.json | 12 +- .../operations/repos/list-pages-builds.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 18 +-- ...st-protected-branch-team-restrictions.json | 28 ++-- ...st-protected-branch-user-restrictions.json | 18 +-- .../operations/repos/list-public.json | 22 ++-- .../operations/repos/list-releases.json | 22 ++-- .../repos/list-statuses-for-ref.json | 28 ++-- .../ghe-2.15/operations/repos/list-tags.json | 22 ++-- .../ghe-2.15/operations/repos/list-teams.json | 22 ++-- .../operations/repos/list-topics.json | 12 +- openapi/ghe-2.15/operations/repos/list.json | 40 +++--- openapi/ghe-2.15/operations/repos/merge.json | 24 ++-- .../ghe-2.15/operations/repos/ping-hook.json | 18 +-- .../repos/remove-branch-protection.json | 18 +-- .../operations/repos/remove-collaborator.json | 18 +-- .../operations/repos/remove-deploy-key.json | 18 +-- ...ve-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...otected-branch-required-status-checks.json | 18 +-- .../remove-protected-branch-restrictions.json | 18 +-- ...ve-protected-branch-team-restrictions.json | 22 ++-- ...ve-protected-branch-user-restrictions.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...ce-protected-branch-team-restrictions.json | 22 ++-- ...ce-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/replace-topics.json | 14 +- .../operations/repos/request-page-build.json | 12 +- .../operations/repos/test-push-hook.json | 18 +-- .../ghe-2.15/operations/repos/transfer.json | 18 +-- .../repos/update-branch-protection.json | 54 ++++---- .../repos/update-commit-comment.json | 22 ++-- .../operations/repos/update-hook.json | 44 +++---- .../update-information-about-pages-site.json | 14 +- .../operations/repos/update-invitation.json | 20 +-- ...ranch-pull-request-review-enforcement.json | 36 +++--- ...otected-branch-required-status-checks.json | 24 ++-- .../repos/update-release-asset.json | 26 ++-- .../operations/repos/update-release.json | 42 +++--- openapi/ghe-2.15/operations/repos/update.json | 46 +++---- openapi/ghe-2.15/operations/search/code.json | 28 ++-- .../ghe-2.15/operations/search/commits.json | 28 ++-- .../operations/search/email-legacy.json | 6 +- .../search/issues-and-pull-requests.json | 28 ++-- .../operations/search/issues-legacy.json | 24 ++-- .../ghe-2.15/operations/search/labels.json | 24 ++-- .../operations/search/repos-legacy.json | 30 ++--- openapi/ghe-2.15/operations/search/repos.json | 28 ++-- .../ghe-2.15/operations/search/topics.json | 6 +- .../operations/search/users-legacy.json | 24 ++-- openapi/ghe-2.15/operations/search/users.json | 28 ++-- .../ghe-2.15/operations/teams/add-member.json | 12 +- .../teams/add-or-update-membership.json | 14 +- .../teams/add-or-update-project.json | 14 +- .../operations/teams/add-or-update-repo.json | 20 +-- .../operations/teams/check-manages-repo.json | 18 +-- .../teams/create-discussion-comment.json | 16 +-- .../operations/teams/create-discussion.json | 16 +-- openapi/ghe-2.15/operations/teams/create.json | 30 ++--- .../teams/delete-discussion-comment.json | 18 +-- .../operations/teams/delete-discussion.json | 12 +- openapi/ghe-2.15/operations/teams/delete.json | 6 +- .../teams/get-discussion-comment.json | 18 +-- .../operations/teams/get-discussion.json | 12 +- .../ghe-2.15/operations/teams/get-member.json | 12 +- .../operations/teams/get-membership.json | 12 +- openapi/ghe-2.15/operations/teams/get.json | 6 +- .../ghe-2.15/operations/teams/list-child.json | 16 +-- .../teams/list-discussion-comments.json | 28 ++-- .../operations/teams/list-discussions.json | 22 ++-- .../teams/list-for-authenticated-user.json | 10 +- .../operations/teams/list-members.json | 22 ++-- .../operations/teams/list-projects.json | 16 +-- .../ghe-2.15/operations/teams/list-repos.json | 16 +-- openapi/ghe-2.15/operations/teams/list.json | 16 +-- .../operations/teams/remove-member.json | 12 +- .../operations/teams/remove-membership.json | 12 +- .../operations/teams/remove-project.json | 12 +- .../operations/teams/remove-repo.json | 18 +-- .../operations/teams/review-project.json | 12 +- .../teams/update-discussion-comment.json | 22 ++-- .../operations/teams/update-discussion.json | 20 +-- openapi/ghe-2.15/operations/teams/update.json | 22 ++-- .../ghe-2.15/operations/users/add-emails.json | 2 +- .../users/check-following-for-user.json | 12 +- .../operations/users/check-following.json | 6 +- .../operations/users/create-gpg-key.json | 4 +- .../operations/users/create-public-key.json | 8 +- .../operations/users/delete-emails.json | 2 +- .../operations/users/delete-gpg-key.json | 6 +- .../operations/users/delete-public-key.json | 6 +- openapi/ghe-2.15/operations/users/follow.json | 6 +- .../operations/users/get-by-username.json | 6 +- .../users/get-context-for-user.json | 18 +-- .../operations/users/get-gpg-key.json | 6 +- .../operations/users/get-public-key.json | 6 +- .../operations/users/list-emails.json | 10 +- ...list-followers-for-authenticated-user.json | 10 +- .../users/list-followers-for-user.json | 16 +-- ...list-following-for-authenticated-user.json | 10 +- .../users/list-following-for-user.json | 16 +-- .../users/list-gpg-keys-for-user.json | 16 +-- .../operations/users/list-gpg-keys.json | 10 +- .../operations/users/list-public-emails.json | 10 +- .../users/list-public-keys-for-user.json | 16 +-- .../operations/users/list-public-keys.json | 10 +- openapi/ghe-2.15/operations/users/list.json | 16 +-- .../ghe-2.15/operations/users/unfollow.json | 6 +- .../users/update-authenticated.json | 28 ++-- .../activity/check-starring-repo.json | 12 +- .../activity/check-watching-repo-legacy.json | 12 +- .../activity/delete-repo-subscription.json | 12 +- .../activity/delete-thread-subscription.json | 6 +- .../activity/get-repo-subscription.json | 12 +- .../activity/get-thread-subscription.json | 6 +- .../operations/activity/get-thread.json | 6 +- .../activity/list-events-for-org.json | 22 ++-- .../activity/list-events-for-user.json | 16 +-- .../activity/list-notifications-for-repo.json | 46 ++++--- .../activity/list-notifications.json | 34 +++-- .../activity/list-public-events-for-org.json | 16 +-- .../list-public-events-for-repo-network.json | 22 ++-- .../activity/list-public-events-for-user.json | 16 +-- .../activity/list-public-events.json | 10 +- .../list-received-events-for-user.json | 16 +-- .../list-received-public-events-for-user.json | 16 +-- .../operations/activity/list-repo-events.json | 22 ++-- ...t-repos-starred-by-authenticated-user.json | 22 ++-- .../activity/list-repos-starred-by-user.json | 28 ++-- .../activity/list-repos-watched-by-user.json | 16 +-- .../activity/list-stargazers-for-repo.json | 22 ++-- ...-watched-repos-for-authenticated-user.json | 10 +- .../activity/list-watchers-for-repo.json | 22 ++-- .../operations/activity/mark-as-read.json | 4 +- .../mark-notifications-as-read-for-repo.json | 16 +-- .../activity/mark-thread-as-read.json | 6 +- .../activity/set-repo-subscription.json | 20 +-- .../activity/set-thread-subscription.json | 8 +- .../operations/activity/star-repo.json | 12 +- .../activity/stop-watching-repo-legacy.json | 12 +- .../operations/activity/unstar-repo.json | 12 +- .../activity/watch-repo-legacy.json | 12 +- .../apps/add-repo-to-installation.json | 12 +- .../apps/create-content-attachment.json | 14 +- .../operations/apps/create-from-manifest.json | 6 +- .../apps/create-installation-token.json | 6 +- .../ghe-2.16/operations/apps/get-by-slug.json | 6 +- .../operations/apps/get-installation.json | 6 +- .../operations/apps/get-org-installation.json | 6 +- .../apps/get-repo-installation.json | 12 +- .../apps/get-user-installation.json | 6 +- ...allation-repos-for-authenticated-user.json | 16 +-- ...-installations-for-authenticated-user.json | 10 +- .../operations/apps/list-installations.json | 10 +- .../ghe-2.16/operations/apps/list-repos.json | 10 +- .../apps/remove-repo-from-installation.json | 12 +- .../operations/checks/create-suite.json | 16 +-- .../ghe-2.16/operations/checks/create.json | 118 ++++++++--------- .../ghe-2.16/operations/checks/get-suite.json | 18 +-- openapi/ghe-2.16/operations/checks/get.json | 18 +-- .../operations/checks/list-annotations.json | 28 ++-- .../operations/checks/list-for-ref.json | 46 ++++--- .../operations/checks/list-for-suite.json | 46 ++++--- .../checks/list-suites-for-ref.json | 40 +++--- .../operations/checks/rerequest-suite.json | 18 +-- .../checks/set-suites-preferences.json | 20 +-- .../ghe-2.16/operations/checks/update.json | 120 +++++++++--------- .../codes-of-conduct/get-conduct-code.json | 6 +- .../codes-of-conduct/get-for-repo.json | 12 +- .../add-authorized-ssh-key.json | 4 +- .../enterprise-admin/create-global-hook.json | 26 ++-- .../create-impersonation-o-auth-token.json | 8 +- .../enterprise-admin/create-org.json | 12 +- .../create-pre-receive-environment.json | 8 +- .../create-pre-receive-hook.json | 20 +-- .../enterprise-admin/create-user.json | 8 +- .../enterprise-admin/delete-global-hook.json | 6 +- .../delete-impersonation-o-auth-token.json | 6 +- .../delete-pre-receive-environment.json | 6 +- .../delete-pre-receive-hook.json | 6 +- .../enterprise-admin/delete-public-key.json | 6 +- .../enterprise-admin/delete-user.json | 6 +- ...e-site-administrator-to-ordinary-user.json | 6 +- .../enable-or-disable-maintenance-mode.json | 4 +- .../enterprise-admin/get-global-hook.json | 6 +- ...e-receive-environment-download-status.json | 24 ++-- .../get-pre-receive-environment.json | 6 +- .../get-pre-receive-hook-for-org.json | 12 +- .../get-pre-receive-hook-for-repo.json | 18 +-- .../get-pre-receive-hook.json | 6 +- .../enterprise-admin/get-type-stats.json | 6 +- .../enterprise-admin/list-global-hooks.json | 10 +- .../list-pre-receive-environments.json | 10 +- .../list-pre-receive-hooks-for-org.json | 16 +-- .../list-pre-receive-hooks-for-repo.json | 22 ++-- .../list-pre-receive-hooks.json | 10 +- .../enterprise-admin/modify-settings.json | 4 +- .../enterprise-admin/ping-global-hook.json | 6 +- ...e-ordinary-user-to-site-administrator.json | 6 +- .../enterprise-admin/queue-indexing-job.json | 4 +- .../remove-authorized-ssh-key.json | 4 +- ...verrides-for-pre-receive-hook-for-org.json | 12 +- ...errides-for-pre-receive-hook-for-repo.json | 18 +-- .../enterprise-admin/rename-org.json | 10 +- .../enterprise-admin/rename-user.json | 10 +- .../enterprise-admin/suspend-user.json | 10 +- .../sync-ldap-mapping-for-team.json | 6 +- .../sync-ldap-mapping-for-user.json | 6 +- ...gger-pre-receive-environment-download.json | 6 +- .../enterprise-admin/unsuspend-user.json | 10 +- .../enterprise-admin/update-global-hook.json | 28 ++-- .../update-ldap-mapping-for-team.json | 10 +- .../update-ldap-mapping-for-user.json | 10 +- .../update-pre-receive-environment.json | 14 +- ...-pre-receive-hook-enforcement-for-org.json | 12 +- ...pre-receive-hook-enforcement-for-repo.json | 18 +-- .../update-pre-receive-hook.json | 6 +- .../enterprise-admin/upgrade-license.json | 4 +- .../upload-license-for-first-time.json | 12 +- .../operations/gists/check-is-starred.json | 6 +- .../operations/gists/create-comment.json | 10 +- openapi/ghe-2.16/operations/gists/create.json | 12 +- .../operations/gists/delete-comment.json | 12 +- openapi/ghe-2.16/operations/gists/delete.json | 6 +- openapi/ghe-2.16/operations/gists/fork.json | 6 +- .../operations/gists/get-comment.json | 12 +- .../operations/gists/get-revision.json | 12 +- openapi/ghe-2.16/operations/gists/get.json | 6 +- .../operations/gists/list-comments.json | 16 +-- .../operations/gists/list-commits.json | 16 +-- .../ghe-2.16/operations/gists/list-forks.json | 16 +-- .../gists/list-public-for-user.json | 22 ++-- .../operations/gists/list-public.json | 16 +-- .../operations/gists/list-starred.json | 16 +-- openapi/ghe-2.16/operations/gists/list.json | 16 +-- openapi/ghe-2.16/operations/gists/star.json | 6 +- openapi/ghe-2.16/operations/gists/unstar.json | 6 +- .../operations/gists/update-comment.json | 16 +-- openapi/ghe-2.16/operations/gists/update.json | 20 +-- .../ghe-2.16/operations/git/create-blob.json | 18 +-- .../operations/git/create-commit.json | 54 ++++---- .../ghe-2.16/operations/git/create-ref.json | 20 +-- .../ghe-2.16/operations/git/create-tag.json | 40 +++--- .../ghe-2.16/operations/git/create-tree.json | 34 ++--- .../ghe-2.16/operations/git/delete-ref.json | 18 +-- openapi/ghe-2.16/operations/git/get-blob.json | 18 +-- .../ghe-2.16/operations/git/get-commit.json | 18 +-- openapi/ghe-2.16/operations/git/get-tag.json | 18 +-- openapi/ghe-2.16/operations/git/get-tree.json | 26 ++-- .../ghe-2.16/operations/git/update-ref.json | 24 ++-- .../operations/gitignore/get-template.json | 6 +- .../operations/issues/add-assignees.json | 20 +-- .../operations/issues/add-labels.json | 20 +-- .../operations/issues/check-assignee.json | 18 +-- .../operations/issues/create-comment.json | 22 ++-- .../operations/issues/create-label.json | 24 ++-- .../operations/issues/create-milestone.json | 26 ++-- .../ghe-2.16/operations/issues/create.json | 32 ++--- .../operations/issues/delete-comment.json | 18 +-- .../operations/issues/delete-label.json | 18 +-- .../operations/issues/delete-milestone.json | 18 +-- .../operations/issues/get-comment.json | 28 ++-- .../ghe-2.16/operations/issues/get-event.json | 18 +-- .../ghe-2.16/operations/issues/get-label.json | 18 +-- .../operations/issues/get-milestone.json | 18 +-- openapi/ghe-2.16/operations/issues/get.json | 18 +-- .../operations/issues/list-assignees.json | 22 ++-- .../issues/list-comments-for-repo.json | 30 ++--- .../operations/issues/list-comments.json | 34 +++-- .../issues/list-events-for-repo.json | 22 ++-- .../issues/list-events-for-timeline.json | 28 ++-- .../operations/issues/list-events.json | 28 ++-- .../issues/list-for-authenticated-user.json | 46 ++++--- .../operations/issues/list-for-org.json | 52 ++++---- .../operations/issues/list-for-repo.json | 76 ++++++----- .../issues/list-labels-for-milestone.json | 28 ++-- .../issues/list-labels-for-repo.json | 22 ++-- .../issues/list-labels-on-issue.json | 28 ++-- .../issues/list-milestones-for-repo.json | 40 +++--- openapi/ghe-2.16/operations/issues/list.json | 46 ++++--- openapi/ghe-2.16/operations/issues/lock.json | 20 +-- .../operations/issues/remove-assignees.json | 20 +-- .../operations/issues/remove-label.json | 24 ++-- .../operations/issues/remove-labels.json | 18 +-- .../operations/issues/replace-labels.json | 20 +-- .../ghe-2.16/operations/issues/unlock.json | 18 +-- .../operations/issues/update-comment.json | 22 ++-- .../operations/issues/update-milestone.json | 32 ++--- .../ghe-2.16/operations/issues/update.json | 38 +++--- .../operations/licenses/get-for-repo.json | 12 +- openapi/ghe-2.16/operations/licenses/get.json | 6 +- .../ghe-2.16/operations/markdown/render.json | 10 +- .../check-authorization.json | 12 +- .../create-authorization.json | 22 ++-- .../delete-authorization.json | 6 +- .../oauth-authorizations/delete-grant.json | 6 +- .../get-authorization.json | 6 +- .../oauth-authorizations/get-grant.json | 6 +- ...authorization-for-app-and-fingerprint.json | 26 ++-- .../get-or-create-authorization-for-app.json | 24 ++-- .../list-authorizations.json | 10 +- .../oauth-authorizations/list-grants.json | 10 +- .../reset-authorization.json | 12 +- .../revoke-authorization-for-application.json | 12 +- .../revoke-grant-for-application.json | 12 +- .../update-authorization.json | 24 ++-- .../orgs/add-or-update-membership.json | 14 +- .../operations/orgs/check-membership.json | 12 +- .../orgs/check-public-membership.json | 12 +- .../operations/orgs/conceal-membership.json | 12 +- ...onvert-member-to-outside-collaborator.json | 12 +- .../ghe-2.16/operations/orgs/create-hook.json | 32 ++--- .../ghe-2.16/operations/orgs/delete-hook.json | 12 +- .../ghe-2.16/operations/orgs/get-hook.json | 12 +- ...get-membership-for-authenticated-user.json | 6 +- .../operations/orgs/get-membership.json | 12 +- openapi/ghe-2.16/operations/orgs/get.json | 6 +- .../orgs/list-for-authenticated-user.json | 10 +- .../operations/orgs/list-for-user.json | 16 +-- .../ghe-2.16/operations/orgs/list-hooks.json | 16 +-- .../operations/orgs/list-members.json | 28 ++-- .../operations/orgs/list-memberships.json | 16 +-- .../orgs/list-outside-collaborators.json | 22 ++-- .../operations/orgs/list-public-members.json | 16 +-- openapi/ghe-2.16/operations/orgs/list.json | 16 +-- .../ghe-2.16/operations/orgs/ping-hook.json | 12 +- .../operations/orgs/publicize-membership.json | 12 +- .../operations/orgs/remove-member.json | 12 +- .../operations/orgs/remove-membership.json | 12 +- .../orgs/remove-outside-collaborator.json | 12 +- .../ghe-2.16/operations/orgs/update-hook.json | 34 ++--- .../operations/orgs/update-membership.json | 8 +- openapi/ghe-2.16/operations/orgs/update.json | 44 +++---- .../operations/projects/add-collaborator.json | 14 +- .../operations/projects/create-card.json | 18 +-- .../operations/projects/create-column.json | 10 +- .../operations/projects/create-for-org.json | 24 ++-- .../operations/projects/create-for-repo.json | 30 ++--- .../operations/projects/delete-card.json | 6 +- .../operations/projects/delete-column.json | 6 +- .../ghe-2.16/operations/projects/delete.json | 6 +- .../operations/projects/get-card.json | 6 +- .../operations/projects/get-column.json | 6 +- openapi/ghe-2.16/operations/projects/get.json | 16 +-- .../operations/projects/list-cards.json | 22 ++-- .../projects/list-collaborators.json | 22 ++-- .../operations/projects/list-columns.json | 16 +-- .../operations/projects/list-for-org.json | 22 ++-- .../operations/projects/list-for-repo.json | 28 ++-- .../operations/projects/move-card.json | 12 +- .../operations/projects/move-column.json | 8 +- .../projects/remove-collaborator.json | 12 +- .../review-user-permission-level.json | 12 +- .../operations/projects/update-card.json | 14 +- .../operations/projects/update-column.json | 10 +- .../ghe-2.16/operations/projects/update.json | 34 +++-- .../operations/pulls/check-if-merged.json | 18 +-- .../pulls/create-comment-reply.json | 26 ++-- .../operations/pulls/create-comment.json | 34 ++--- .../operations/pulls/create-from-issue.json | 28 ++-- .../pulls/create-review-request.json | 22 ++-- .../operations/pulls/create-review.json | 42 +++--- openapi/ghe-2.16/operations/pulls/create.json | 32 ++--- .../operations/pulls/delete-comment.json | 18 +-- .../pulls/delete-pending-review.json | 24 ++-- .../pulls/delete-review-request.json | 22 ++-- .../operations/pulls/dismiss-review.json | 28 ++-- .../operations/pulls/get-comment.json | 18 +-- .../pulls/get-comments-for-review.json | 34 +++-- .../ghe-2.16/operations/pulls/get-review.json | 24 ++-- openapi/ghe-2.16/operations/pulls/get.json | 18 +-- .../pulls/list-comments-for-repo.json | 40 +++--- .../operations/pulls/list-comments.json | 46 ++++--- .../operations/pulls/list-commits.json | 28 ++-- .../ghe-2.16/operations/pulls/list-files.json | 28 ++-- .../pulls/list-review-requests.json | 28 ++-- .../operations/pulls/list-reviews.json | 28 ++-- openapi/ghe-2.16/operations/pulls/list.json | 52 ++++---- openapi/ghe-2.16/operations/pulls/merge.json | 32 ++--- .../operations/pulls/submit-review.json | 30 ++--- .../operations/pulls/update-comment.json | 22 ++-- openapi/ghe-2.16/operations/pulls/update.json | 36 +++--- .../reactions/create-for-commit-comment.json | 20 +-- .../reactions/create-for-issue-comment.json | 20 +-- .../reactions/create-for-issue.json | 20 +-- ...reate-for-pull-request-review-comment.json | 20 +-- .../create-for-team-discussion-comment.json | 20 +-- .../reactions/create-for-team-discussion.json | 14 +- .../ghe-2.16/operations/reactions/delete.json | 6 +- .../reactions/list-for-commit-comment.json | 34 +++-- .../reactions/list-for-issue-comment.json | 34 +++-- .../operations/reactions/list-for-issue.json | 34 +++-- .../list-for-pull-request-review-comment.json | 34 +++-- .../list-for-team-discussion-comment.json | 34 +++-- .../reactions/list-for-team-discussion.json | 28 ++-- .../operations/repos/accept-invitation.json | 6 +- .../operations/repos/add-collaborator.json | 20 +-- .../operations/repos/add-deploy-key.json | 24 ++-- ...dd-protected-branch-admin-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...dd-protected-branch-team-restrictions.json | 22 ++-- ...dd-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/check-collaborator.json | 18 +-- .../operations/repos/compare-commits.json | 24 ++-- .../repos/create-commit-comment.json | 34 ++--- .../repos/create-deployment-status.json | 32 ++--- .../operations/repos/create-deployment.json | 34 ++--- .../repos/create-for-authenticated-user.json | 40 +++--- .../operations/repos/create-fork.json | 16 +-- .../operations/repos/create-hook.json | 36 +++--- .../operations/repos/create-in-org.json | 46 +++---- .../repos/create-or-update-file.json | 54 ++++---- .../operations/repos/create-release.json | 32 ++--- .../operations/repos/create-status.json | 30 ++--- .../operations/repos/decline-invitation.json | 6 +- .../repos/delete-commit-comment.json | 18 +-- .../operations/repos/delete-download.json | 18 +-- .../operations/repos/delete-file.json | 50 ++++---- .../operations/repos/delete-hook.json | 18 +-- .../operations/repos/delete-invitation.json | 18 +-- .../repos/delete-release-asset.json | 18 +-- .../operations/repos/delete-release.json | 18 +-- openapi/ghe-2.16/operations/repos/delete.json | 12 +- .../operations/repos/get-archive-link.json | 24 ++-- .../repos/get-branch-protection.json | 18 +-- .../ghe-2.16/operations/repos/get-branch.json | 18 +-- .../repos/get-code-frequency-stats.json | 12 +- .../get-collaborator-permission-level.json | 18 +-- .../repos/get-combined-status-for-ref.json | 18 +-- .../repos/get-commit-activity-stats.json | 12 +- .../operations/repos/get-commit-comment.json | 18 +-- .../ghe-2.16/operations/repos/get-commit.json | 18 +-- .../operations/repos/get-contents.json | 24 ++-- .../repos/get-contributors-stats.json | 12 +- .../operations/repos/get-deploy-key.json | 18 +-- .../repos/get-deployment-status.json | 24 ++-- .../operations/repos/get-deployment.json | 18 +-- .../operations/repos/get-download.json | 18 +-- .../ghe-2.16/operations/repos/get-hook.json | 18 +-- .../repos/get-latest-pages-build.json | 12 +- .../operations/repos/get-latest-release.json | 12 +- .../operations/repos/get-pages-build.json | 18 +-- .../ghe-2.16/operations/repos/get-pages.json | 12 +- .../repos/get-participation-stats.json | 12 +- ...et-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...otected-branch-required-status-checks.json | 18 +-- .../get-protected-branch-restrictions.json | 18 +-- .../repos/get-punch-card-stats.json | 12 +- .../ghe-2.16/operations/repos/get-readme.json | 18 +-- .../operations/repos/get-release-asset.json | 18 +-- .../operations/repos/get-release-by-tag.json | 18 +-- .../operations/repos/get-release.json | 18 +-- openapi/ghe-2.16/operations/repos/get.json | 12 +- .../repos/list-assets-for-release.json | 28 ++-- .../operations/repos/list-branches.json | 28 ++-- .../operations/repos/list-collaborators.json | 28 ++-- .../repos/list-comments-for-commit.json | 28 ++-- .../repos/list-commit-comments.json | 22 ++-- .../operations/repos/list-commits.json | 52 ++++---- .../operations/repos/list-contributors.json | 28 ++-- .../operations/repos/list-deploy-keys.json | 22 ++-- .../repos/list-deployment-statuses.json | 28 ++-- .../operations/repos/list-deployments.json | 46 ++++--- .../operations/repos/list-downloads.json | 22 ++-- .../operations/repos/list-for-org.json | 22 ++-- .../operations/repos/list-for-user.json | 34 +++-- .../ghe-2.16/operations/repos/list-forks.json | 28 ++-- .../ghe-2.16/operations/repos/list-hooks.json | 22 ++-- ...st-invitations-for-authenticated-user.json | 10 +- .../operations/repos/list-invitations.json | 22 ++-- .../operations/repos/list-languages.json | 12 +- .../operations/repos/list-pages-builds.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 18 +-- ...st-protected-branch-team-restrictions.json | 28 ++-- ...st-protected-branch-user-restrictions.json | 18 +-- .../operations/repos/list-public.json | 22 ++-- .../operations/repos/list-releases.json | 22 ++-- .../repos/list-statuses-for-ref.json | 28 ++-- .../ghe-2.16/operations/repos/list-tags.json | 22 ++-- .../ghe-2.16/operations/repos/list-teams.json | 22 ++-- .../operations/repos/list-topics.json | 12 +- openapi/ghe-2.16/operations/repos/list.json | 40 +++--- openapi/ghe-2.16/operations/repos/merge.json | 24 ++-- .../ghe-2.16/operations/repos/ping-hook.json | 18 +-- .../repos/remove-branch-protection.json | 18 +-- .../operations/repos/remove-collaborator.json | 18 +-- .../operations/repos/remove-deploy-key.json | 18 +-- ...ve-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...otected-branch-required-status-checks.json | 18 +-- .../remove-protected-branch-restrictions.json | 18 +-- ...ve-protected-branch-team-restrictions.json | 22 ++-- ...ve-protected-branch-user-restrictions.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...ce-protected-branch-team-restrictions.json | 22 ++-- ...ce-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/replace-topics.json | 14 +- .../operations/repos/request-page-build.json | 12 +- .../operations/repos/test-push-hook.json | 18 +-- .../ghe-2.16/operations/repos/transfer.json | 18 +-- .../repos/update-branch-protection.json | 54 ++++---- .../repos/update-commit-comment.json | 22 ++-- .../operations/repos/update-hook.json | 44 +++---- .../update-information-about-pages-site.json | 14 +- .../operations/repos/update-invitation.json | 20 +-- ...ranch-pull-request-review-enforcement.json | 36 +++--- ...otected-branch-required-status-checks.json | 24 ++-- .../repos/update-release-asset.json | 26 ++-- .../operations/repos/update-release.json | 42 +++--- openapi/ghe-2.16/operations/repos/update.json | 46 +++---- openapi/ghe-2.16/operations/search/code.json | 28 ++-- .../ghe-2.16/operations/search/commits.json | 28 ++-- .../operations/search/email-legacy.json | 6 +- .../search/issues-and-pull-requests.json | 28 ++-- .../operations/search/issues-legacy.json | 24 ++-- .../ghe-2.16/operations/search/labels.json | 24 ++-- .../operations/search/repos-legacy.json | 30 ++--- openapi/ghe-2.16/operations/search/repos.json | 28 ++-- .../ghe-2.16/operations/search/topics.json | 6 +- .../operations/search/users-legacy.json | 24 ++-- openapi/ghe-2.16/operations/search/users.json | 28 ++-- .../ghe-2.16/operations/teams/add-member.json | 12 +- .../teams/add-or-update-membership.json | 14 +- .../teams/add-or-update-project.json | 14 +- .../operations/teams/add-or-update-repo.json | 20 +-- .../operations/teams/check-manages-repo.json | 18 +-- .../teams/create-discussion-comment.json | 16 +-- .../operations/teams/create-discussion.json | 16 +-- openapi/ghe-2.16/operations/teams/create.json | 30 ++--- .../teams/delete-discussion-comment.json | 18 +-- .../operations/teams/delete-discussion.json | 12 +- openapi/ghe-2.16/operations/teams/delete.json | 6 +- .../teams/get-discussion-comment.json | 18 +-- .../operations/teams/get-discussion.json | 12 +- .../ghe-2.16/operations/teams/get-member.json | 12 +- .../operations/teams/get-membership.json | 12 +- openapi/ghe-2.16/operations/teams/get.json | 6 +- .../ghe-2.16/operations/teams/list-child.json | 16 +-- .../teams/list-discussion-comments.json | 28 ++-- .../operations/teams/list-discussions.json | 22 ++-- .../teams/list-for-authenticated-user.json | 10 +- .../operations/teams/list-members.json | 22 ++-- .../operations/teams/list-projects.json | 16 +-- .../ghe-2.16/operations/teams/list-repos.json | 16 +-- openapi/ghe-2.16/operations/teams/list.json | 16 +-- .../operations/teams/remove-member.json | 12 +- .../operations/teams/remove-membership.json | 12 +- .../operations/teams/remove-project.json | 12 +- .../operations/teams/remove-repo.json | 18 +-- .../operations/teams/review-project.json | 12 +- .../teams/update-discussion-comment.json | 22 ++-- .../operations/teams/update-discussion.json | 20 +-- openapi/ghe-2.16/operations/teams/update.json | 22 ++-- .../ghe-2.16/operations/users/add-emails.json | 2 +- .../users/check-following-for-user.json | 12 +- .../operations/users/check-following.json | 6 +- .../operations/users/create-gpg-key.json | 4 +- .../operations/users/create-public-key.json | 8 +- .../operations/users/delete-emails.json | 2 +- .../operations/users/delete-gpg-key.json | 6 +- .../operations/users/delete-public-key.json | 6 +- openapi/ghe-2.16/operations/users/follow.json | 6 +- .../operations/users/get-by-username.json | 6 +- .../users/get-context-for-user.json | 18 +-- .../operations/users/get-gpg-key.json | 6 +- .../operations/users/get-public-key.json | 6 +- .../operations/users/list-emails.json | 10 +- ...list-followers-for-authenticated-user.json | 10 +- .../users/list-followers-for-user.json | 16 +-- ...list-following-for-authenticated-user.json | 10 +- .../users/list-following-for-user.json | 16 +-- .../users/list-gpg-keys-for-user.json | 16 +-- .../operations/users/list-gpg-keys.json | 10 +- .../operations/users/list-public-emails.json | 10 +- .../users/list-public-keys-for-user.json | 16 +-- .../operations/users/list-public-keys.json | 10 +- openapi/ghe-2.16/operations/users/list.json | 16 +-- .../ghe-2.16/operations/users/unfollow.json | 6 +- .../users/update-authenticated.json | 28 ++-- .../activity/check-starring-repo.json | 12 +- .../activity/check-watching-repo-legacy.json | 12 +- .../activity/delete-repo-subscription.json | 12 +- .../activity/delete-thread-subscription.json | 6 +- .../activity/get-repo-subscription.json | 12 +- .../activity/get-thread-subscription.json | 6 +- .../operations/activity/get-thread.json | 6 +- .../activity/list-events-for-org.json | 22 ++-- .../activity/list-events-for-user.json | 16 +-- .../activity/list-notifications-for-repo.json | 46 ++++--- .../activity/list-notifications.json | 34 +++-- .../activity/list-public-events-for-org.json | 16 +-- .../list-public-events-for-repo-network.json | 22 ++-- .../activity/list-public-events-for-user.json | 16 +-- .../activity/list-public-events.json | 10 +- .../list-received-events-for-user.json | 16 +-- .../list-received-public-events-for-user.json | 16 +-- .../operations/activity/list-repo-events.json | 22 ++-- ...t-repos-starred-by-authenticated-user.json | 22 ++-- .../activity/list-repos-starred-by-user.json | 28 ++-- .../activity/list-repos-watched-by-user.json | 16 +-- .../activity/list-stargazers-for-repo.json | 22 ++-- ...-watched-repos-for-authenticated-user.json | 10 +- .../activity/list-watchers-for-repo.json | 22 ++-- .../operations/activity/mark-as-read.json | 4 +- .../mark-notifications-as-read-for-repo.json | 16 +-- .../activity/mark-thread-as-read.json | 6 +- .../activity/set-repo-subscription.json | 20 +-- .../activity/set-thread-subscription.json | 8 +- .../operations/activity/star-repo.json | 12 +- .../activity/stop-watching-repo-legacy.json | 12 +- .../operations/activity/unstar-repo.json | 12 +- .../activity/watch-repo-legacy.json | 12 +- .../apps/add-repo-to-installation.json | 12 +- .../apps/create-content-attachment.json | 14 +- .../operations/apps/create-from-manifest.json | 6 +- .../apps/create-installation-token.json | 10 +- .../operations/apps/delete-installation.json | 6 +- .../ghe-2.17/operations/apps/get-by-slug.json | 6 +- .../operations/apps/get-installation.json | 6 +- .../operations/apps/get-org-installation.json | 6 +- .../apps/get-repo-installation.json | 12 +- .../apps/get-user-installation.json | 6 +- ...allation-repos-for-authenticated-user.json | 16 +-- ...-installations-for-authenticated-user.json | 10 +- .../operations/apps/list-installations.json | 10 +- .../ghe-2.17/operations/apps/list-repos.json | 10 +- .../apps/remove-repo-from-installation.json | 12 +- .../operations/checks/create-suite.json | 16 +-- .../ghe-2.17/operations/checks/create.json | 118 ++++++++--------- .../ghe-2.17/operations/checks/get-suite.json | 18 +-- openapi/ghe-2.17/operations/checks/get.json | 18 +-- .../operations/checks/list-annotations.json | 28 ++-- .../operations/checks/list-for-ref.json | 46 ++++--- .../operations/checks/list-for-suite.json | 46 ++++--- .../checks/list-suites-for-ref.json | 40 +++--- .../operations/checks/rerequest-suite.json | 18 +-- .../checks/set-suites-preferences.json | 20 +-- .../ghe-2.17/operations/checks/update.json | 120 +++++++++--------- .../codes-of-conduct/get-conduct-code.json | 6 +- .../codes-of-conduct/get-for-repo.json | 12 +- .../add-authorized-ssh-key.json | 4 +- .../enterprise-admin/create-global-hook.json | 26 ++-- .../create-impersonation-o-auth-token.json | 8 +- .../enterprise-admin/create-org.json | 12 +- .../create-pre-receive-environment.json | 8 +- .../create-pre-receive-hook.json | 20 +-- .../enterprise-admin/create-user.json | 8 +- .../enterprise-admin/delete-global-hook.json | 6 +- .../delete-impersonation-o-auth-token.json | 6 +- .../delete-personal-access-token.json | 6 +- .../delete-pre-receive-environment.json | 6 +- .../delete-pre-receive-hook.json | 6 +- .../enterprise-admin/delete-public-key.json | 6 +- .../enterprise-admin/delete-user.json | 6 +- ...e-site-administrator-to-ordinary-user.json | 6 +- .../enable-or-disable-maintenance-mode.json | 4 +- .../enterprise-admin/get-global-hook.json | 6 +- ...e-receive-environment-download-status.json | 24 ++-- .../get-pre-receive-environment.json | 6 +- .../get-pre-receive-hook-for-org.json | 12 +- .../get-pre-receive-hook-for-repo.json | 18 +-- .../get-pre-receive-hook.json | 6 +- .../enterprise-admin/get-type-stats.json | 6 +- .../enterprise-admin/list-global-hooks.json | 10 +- .../list-personal-access-tokens.json | 10 +- .../list-pre-receive-environments.json | 10 +- .../list-pre-receive-hooks-for-org.json | 16 +-- .../list-pre-receive-hooks-for-repo.json | 22 ++-- .../list-pre-receive-hooks.json | 10 +- .../enterprise-admin/modify-settings.json | 4 +- .../enterprise-admin/ping-global-hook.json | 6 +- ...e-ordinary-user-to-site-administrator.json | 6 +- .../enterprise-admin/queue-indexing-job.json | 4 +- .../remove-authorized-ssh-key.json | 4 +- ...verrides-for-pre-receive-hook-for-org.json | 12 +- ...errides-for-pre-receive-hook-for-repo.json | 18 +-- .../enterprise-admin/rename-org.json | 10 +- .../enterprise-admin/rename-user.json | 10 +- .../enterprise-admin/suspend-user.json | 10 +- .../sync-ldap-mapping-for-team.json | 6 +- .../sync-ldap-mapping-for-user.json | 6 +- ...gger-pre-receive-environment-download.json | 6 +- .../enterprise-admin/unsuspend-user.json | 10 +- .../enterprise-admin/update-global-hook.json | 28 ++-- .../update-ldap-mapping-for-team.json | 10 +- .../update-ldap-mapping-for-user.json | 10 +- .../update-pre-receive-environment.json | 14 +- ...-pre-receive-hook-enforcement-for-org.json | 12 +- ...pre-receive-hook-enforcement-for-repo.json | 18 +-- .../update-pre-receive-hook.json | 6 +- .../enterprise-admin/upgrade-license.json | 4 +- .../upload-license-for-first-time.json | 12 +- .../operations/gists/check-is-starred.json | 6 +- .../operations/gists/create-comment.json | 10 +- openapi/ghe-2.17/operations/gists/create.json | 12 +- .../operations/gists/delete-comment.json | 12 +- openapi/ghe-2.17/operations/gists/delete.json | 6 +- openapi/ghe-2.17/operations/gists/fork.json | 6 +- .../operations/gists/get-comment.json | 12 +- .../operations/gists/get-revision.json | 12 +- openapi/ghe-2.17/operations/gists/get.json | 6 +- .../operations/gists/list-comments.json | 16 +-- .../operations/gists/list-commits.json | 16 +-- .../ghe-2.17/operations/gists/list-forks.json | 16 +-- .../gists/list-public-for-user.json | 22 ++-- .../operations/gists/list-public.json | 16 +-- .../operations/gists/list-starred.json | 16 +-- openapi/ghe-2.17/operations/gists/list.json | 16 +-- openapi/ghe-2.17/operations/gists/star.json | 6 +- openapi/ghe-2.17/operations/gists/unstar.json | 6 +- .../operations/gists/update-comment.json | 16 +-- openapi/ghe-2.17/operations/gists/update.json | 20 +-- .../ghe-2.17/operations/git/create-blob.json | 18 +-- .../operations/git/create-commit.json | 54 ++++---- .../ghe-2.17/operations/git/create-ref.json | 20 +-- .../ghe-2.17/operations/git/create-tag.json | 40 +++--- .../ghe-2.17/operations/git/create-tree.json | 34 ++--- .../ghe-2.17/operations/git/delete-ref.json | 18 +-- openapi/ghe-2.17/operations/git/get-blob.json | 18 +-- .../ghe-2.17/operations/git/get-commit.json | 18 +-- openapi/ghe-2.17/operations/git/get-tag.json | 18 +-- openapi/ghe-2.17/operations/git/get-tree.json | 26 ++-- .../ghe-2.17/operations/git/update-ref.json | 24 ++-- .../operations/gitignore/get-template.json | 6 +- .../operations/issues/add-assignees.json | 20 +-- .../operations/issues/add-labels.json | 20 +-- .../operations/issues/check-assignee.json | 18 +-- .../operations/issues/create-comment.json | 22 ++-- .../operations/issues/create-label.json | 24 ++-- .../operations/issues/create-milestone.json | 26 ++-- .../ghe-2.17/operations/issues/create.json | 32 ++--- .../operations/issues/delete-comment.json | 18 +-- .../operations/issues/delete-label.json | 18 +-- .../operations/issues/delete-milestone.json | 18 +-- .../operations/issues/get-comment.json | 28 ++-- .../ghe-2.17/operations/issues/get-event.json | 18 +-- .../ghe-2.17/operations/issues/get-label.json | 18 +-- .../operations/issues/get-milestone.json | 18 +-- openapi/ghe-2.17/operations/issues/get.json | 18 +-- .../operations/issues/list-assignees.json | 22 ++-- .../issues/list-comments-for-repo.json | 30 ++--- .../operations/issues/list-comments.json | 34 +++-- .../issues/list-events-for-repo.json | 22 ++-- .../issues/list-events-for-timeline.json | 28 ++-- .../operations/issues/list-events.json | 28 ++-- .../issues/list-for-authenticated-user.json | 46 ++++--- .../operations/issues/list-for-org.json | 52 ++++---- .../operations/issues/list-for-repo.json | 76 ++++++----- .../issues/list-labels-for-milestone.json | 28 ++-- .../issues/list-labels-for-repo.json | 22 ++-- .../issues/list-labels-on-issue.json | 28 ++-- .../issues/list-milestones-for-repo.json | 40 +++--- openapi/ghe-2.17/operations/issues/list.json | 46 ++++--- openapi/ghe-2.17/operations/issues/lock.json | 20 +-- .../operations/issues/remove-assignees.json | 20 +-- .../operations/issues/remove-label.json | 24 ++-- .../operations/issues/remove-labels.json | 18 +-- .../operations/issues/replace-labels.json | 20 +-- .../ghe-2.17/operations/issues/unlock.json | 18 +-- .../operations/issues/update-comment.json | 22 ++-- .../operations/issues/update-milestone.json | 32 ++--- .../ghe-2.17/operations/issues/update.json | 38 +++--- .../operations/licenses/get-for-repo.json | 12 +- openapi/ghe-2.17/operations/licenses/get.json | 6 +- .../ghe-2.17/operations/markdown/render.json | 10 +- .../check-authorization.json | 12 +- .../create-authorization.json | 22 ++-- .../delete-authorization.json | 6 +- .../oauth-authorizations/delete-grant.json | 6 +- .../get-authorization.json | 6 +- .../oauth-authorizations/get-grant.json | 6 +- ...authorization-for-app-and-fingerprint.json | 26 ++-- .../get-or-create-authorization-for-app.json | 24 ++-- .../list-authorizations.json | 10 +- .../oauth-authorizations/list-grants.json | 10 +- .../reset-authorization.json | 12 +- .../revoke-authorization-for-application.json | 12 +- .../revoke-grant-for-application.json | 12 +- .../update-authorization.json | 24 ++-- .../orgs/add-or-update-membership.json | 14 +- .../operations/orgs/check-membership.json | 12 +- .../orgs/check-public-membership.json | 12 +- .../operations/orgs/conceal-membership.json | 12 +- ...onvert-member-to-outside-collaborator.json | 12 +- .../ghe-2.17/operations/orgs/create-hook.json | 32 ++--- .../ghe-2.17/operations/orgs/delete-hook.json | 12 +- .../ghe-2.17/operations/orgs/get-hook.json | 12 +- ...get-membership-for-authenticated-user.json | 6 +- .../operations/orgs/get-membership.json | 12 +- openapi/ghe-2.17/operations/orgs/get.json | 6 +- .../orgs/list-for-authenticated-user.json | 10 +- .../operations/orgs/list-for-user.json | 16 +-- .../ghe-2.17/operations/orgs/list-hooks.json | 16 +-- .../operations/orgs/list-members.json | 28 ++-- .../operations/orgs/list-memberships.json | 16 +-- .../orgs/list-outside-collaborators.json | 22 ++-- .../operations/orgs/list-public-members.json | 16 +-- openapi/ghe-2.17/operations/orgs/list.json | 16 +-- .../ghe-2.17/operations/orgs/ping-hook.json | 12 +- .../operations/orgs/publicize-membership.json | 12 +- .../operations/orgs/remove-member.json | 12 +- .../operations/orgs/remove-membership.json | 12 +- .../orgs/remove-outside-collaborator.json | 12 +- .../ghe-2.17/operations/orgs/update-hook.json | 34 ++--- .../operations/orgs/update-membership.json | 8 +- openapi/ghe-2.17/operations/orgs/update.json | 44 +++---- .../operations/projects/add-collaborator.json | 14 +- .../operations/projects/create-card.json | 18 +-- .../operations/projects/create-column.json | 10 +- .../create-for-authenticated-user.json | 18 ++- .../operations/projects/create-for-org.json | 24 ++-- .../operations/projects/create-for-repo.json | 30 ++--- .../operations/projects/delete-card.json | 6 +- .../operations/projects/delete-column.json | 6 +- .../ghe-2.17/operations/projects/delete.json | 6 +- .../operations/projects/get-card.json | 6 +- .../operations/projects/get-column.json | 6 +- openapi/ghe-2.17/operations/projects/get.json | 16 +-- .../operations/projects/list-cards.json | 22 ++-- .../projects/list-collaborators.json | 22 ++-- .../operations/projects/list-columns.json | 16 +-- .../operations/projects/list-for-org.json | 22 ++-- .../operations/projects/list-for-repo.json | 28 ++-- .../operations/projects/list-for-user.json | 22 ++-- .../operations/projects/move-card.json | 12 +- .../operations/projects/move-column.json | 8 +- .../projects/remove-collaborator.json | 12 +- .../review-user-permission-level.json | 12 +- .../operations/projects/update-card.json | 14 +- .../operations/projects/update-column.json | 10 +- .../ghe-2.17/operations/projects/update.json | 34 +++-- .../operations/pulls/check-if-merged.json | 18 +-- .../pulls/create-comment-reply.json | 26 ++-- .../operations/pulls/create-comment.json | 34 ++--- .../operations/pulls/create-from-issue.json | 32 ++--- .../pulls/create-review-request.json | 22 ++-- .../operations/pulls/create-review.json | 42 +++--- openapi/ghe-2.17/operations/pulls/create.json | 36 +++--- .../operations/pulls/delete-comment.json | 18 +-- .../pulls/delete-pending-review.json | 24 ++-- .../pulls/delete-review-request.json | 22 ++-- .../operations/pulls/dismiss-review.json | 28 ++-- .../operations/pulls/get-comment.json | 18 +-- .../pulls/get-comments-for-review.json | 34 +++-- .../ghe-2.17/operations/pulls/get-review.json | 24 ++-- openapi/ghe-2.17/operations/pulls/get.json | 18 +-- .../pulls/list-comments-for-repo.json | 40 +++--- .../operations/pulls/list-comments.json | 46 ++++--- .../operations/pulls/list-commits.json | 28 ++-- .../ghe-2.17/operations/pulls/list-files.json | 28 ++-- .../pulls/list-review-requests.json | 28 ++-- .../operations/pulls/list-reviews.json | 28 ++-- openapi/ghe-2.17/operations/pulls/list.json | 52 ++++---- openapi/ghe-2.17/operations/pulls/merge.json | 32 ++--- .../operations/pulls/submit-review.json | 30 ++--- .../operations/pulls/update-comment.json | 22 ++-- .../operations/pulls/update-review.json | 28 ++-- openapi/ghe-2.17/operations/pulls/update.json | 36 +++--- .../reactions/create-for-commit-comment.json | 20 +-- .../reactions/create-for-issue-comment.json | 20 +-- .../reactions/create-for-issue.json | 20 +-- ...reate-for-pull-request-review-comment.json | 20 +-- .../create-for-team-discussion-comment.json | 20 +-- .../reactions/create-for-team-discussion.json | 14 +- .../ghe-2.17/operations/reactions/delete.json | 6 +- .../reactions/list-for-commit-comment.json | 34 +++-- .../reactions/list-for-issue-comment.json | 34 +++-- .../operations/reactions/list-for-issue.json | 34 +++-- .../list-for-pull-request-review-comment.json | 34 +++-- .../list-for-team-discussion-comment.json | 34 +++-- .../reactions/list-for-team-discussion.json | 28 ++-- .../operations/repos/accept-invitation.json | 6 +- .../operations/repos/add-collaborator.json | 20 +-- .../operations/repos/add-deploy-key.json | 24 ++-- ...dd-protected-branch-admin-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...dd-protected-branch-team-restrictions.json | 22 ++-- ...dd-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/check-collaborator.json | 18 +-- .../operations/repos/compare-commits.json | 24 ++-- .../repos/create-commit-comment.json | 34 ++--- .../repos/create-deployment-status.json | 32 ++--- .../operations/repos/create-deployment.json | 34 ++--- .../repos/create-for-authenticated-user.json | 40 +++--- .../operations/repos/create-fork.json | 16 +-- .../operations/repos/create-hook.json | 36 +++--- .../operations/repos/create-in-org.json | 46 +++---- .../repos/create-or-update-file.json | 54 ++++---- .../operations/repos/create-release.json | 32 ++--- .../operations/repos/create-status.json | 30 ++--- .../operations/repos/decline-invitation.json | 6 +- .../repos/delete-commit-comment.json | 18 +-- .../operations/repos/delete-download.json | 18 +-- .../operations/repos/delete-file.json | 50 ++++---- .../operations/repos/delete-hook.json | 18 +-- .../operations/repos/delete-invitation.json | 18 +-- .../repos/delete-release-asset.json | 18 +-- .../operations/repos/delete-release.json | 18 +-- openapi/ghe-2.17/operations/repos/delete.json | 12 +- .../operations/repos/disable-pages-site.json | 12 +- .../operations/repos/enable-pages-site.json | 20 +-- .../operations/repos/get-archive-link.json | 24 ++-- .../repos/get-branch-protection.json | 18 +-- .../ghe-2.17/operations/repos/get-branch.json | 18 +-- .../repos/get-code-frequency-stats.json | 12 +- .../get-collaborator-permission-level.json | 18 +-- .../repos/get-combined-status-for-ref.json | 18 +-- .../repos/get-commit-activity-stats.json | 12 +- .../operations/repos/get-commit-comment.json | 18 +-- .../ghe-2.17/operations/repos/get-commit.json | 18 +-- .../operations/repos/get-contents.json | 24 ++-- .../repos/get-contributors-stats.json | 12 +- .../operations/repos/get-deploy-key.json | 18 +-- .../repos/get-deployment-status.json | 24 ++-- .../operations/repos/get-deployment.json | 18 +-- .../operations/repos/get-download.json | 18 +-- .../ghe-2.17/operations/repos/get-hook.json | 18 +-- .../repos/get-latest-pages-build.json | 12 +- .../operations/repos/get-latest-release.json | 12 +- .../operations/repos/get-pages-build.json | 18 +-- .../ghe-2.17/operations/repos/get-pages.json | 12 +- .../repos/get-participation-stats.json | 12 +- ...et-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...otected-branch-required-status-checks.json | 18 +-- .../get-protected-branch-restrictions.json | 18 +-- .../repos/get-punch-card-stats.json | 12 +- .../ghe-2.17/operations/repos/get-readme.json | 18 +-- .../operations/repos/get-release-asset.json | 18 +-- .../operations/repos/get-release-by-tag.json | 18 +-- .../operations/repos/get-release.json | 18 +-- openapi/ghe-2.17/operations/repos/get.json | 12 +- .../repos/list-assets-for-release.json | 28 ++-- .../repos/list-branches-for-head-commit.json | 18 +-- .../operations/repos/list-branches.json | 28 ++-- .../operations/repos/list-collaborators.json | 28 ++-- .../repos/list-comments-for-commit.json | 28 ++-- .../repos/list-commit-comments.json | 22 ++-- .../operations/repos/list-commits.json | 52 ++++---- .../operations/repos/list-contributors.json | 28 ++-- .../operations/repos/list-deploy-keys.json | 22 ++-- .../repos/list-deployment-statuses.json | 28 ++-- .../operations/repos/list-deployments.json | 46 ++++--- .../operations/repos/list-downloads.json | 22 ++-- .../operations/repos/list-for-org.json | 34 +++-- .../operations/repos/list-for-user.json | 34 +++-- .../ghe-2.17/operations/repos/list-forks.json | 28 ++-- .../ghe-2.17/operations/repos/list-hooks.json | 22 ++-- ...st-invitations-for-authenticated-user.json | 10 +- .../operations/repos/list-invitations.json | 22 ++-- .../operations/repos/list-languages.json | 12 +- .../operations/repos/list-pages-builds.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 18 +-- ...st-protected-branch-team-restrictions.json | 28 ++-- ...st-protected-branch-user-restrictions.json | 18 +-- .../operations/repos/list-public.json | 22 ++-- ...-pull-requests-associated-with-commit.json | 28 ++-- .../operations/repos/list-releases.json | 22 ++-- .../repos/list-statuses-for-ref.json | 28 ++-- .../ghe-2.17/operations/repos/list-tags.json | 22 ++-- .../ghe-2.17/operations/repos/list-teams.json | 22 ++-- .../operations/repos/list-topics.json | 12 +- openapi/ghe-2.17/operations/repos/list.json | 40 +++--- openapi/ghe-2.17/operations/repos/merge.json | 24 ++-- .../ghe-2.17/operations/repos/ping-hook.json | 18 +-- .../repos/remove-branch-protection.json | 18 +-- .../operations/repos/remove-collaborator.json | 18 +-- .../operations/repos/remove-deploy-key.json | 18 +-- ...ve-protected-branch-admin-enforcement.json | 18 +-- ...ranch-pull-request-review-enforcement.json | 18 +-- ...-protected-branch-required-signatures.json | 18 +-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...otected-branch-required-status-checks.json | 18 +-- .../remove-protected-branch-restrictions.json | 18 +-- ...ve-protected-branch-team-restrictions.json | 22 ++-- ...ve-protected-branch-user-restrictions.json | 22 ++-- ...ranch-required-status-checks-contexts.json | 22 ++-- ...ce-protected-branch-team-restrictions.json | 22 ++-- ...ce-protected-branch-user-restrictions.json | 22 ++-- .../operations/repos/replace-topics.json | 14 +- .../operations/repos/request-page-build.json | 12 +- .../operations/repos/test-push-hook.json | 18 +-- .../ghe-2.17/operations/repos/transfer.json | 18 +-- .../repos/update-branch-protection.json | 54 ++++---- .../repos/update-commit-comment.json | 22 ++-- .../operations/repos/update-hook.json | 44 +++---- .../update-information-about-pages-site.json | 14 +- .../operations/repos/update-invitation.json | 20 +-- ...ranch-pull-request-review-enforcement.json | 36 +++--- ...otected-branch-required-status-checks.json | 24 ++-- .../repos/update-release-asset.json | 26 ++-- .../operations/repos/update-release.json | 42 +++--- openapi/ghe-2.17/operations/repos/update.json | 46 +++---- openapi/ghe-2.17/operations/search/code.json | 28 ++-- .../ghe-2.17/operations/search/commits.json | 28 ++-- .../operations/search/email-legacy.json | 6 +- .../search/issues-and-pull-requests.json | 28 ++-- .../operations/search/issues-legacy.json | 24 ++-- .../ghe-2.17/operations/search/labels.json | 24 ++-- .../operations/search/repos-legacy.json | 30 ++--- openapi/ghe-2.17/operations/search/repos.json | 28 ++-- .../ghe-2.17/operations/search/topics.json | 6 +- .../operations/search/users-legacy.json | 24 ++-- openapi/ghe-2.17/operations/search/users.json | 28 ++-- .../ghe-2.17/operations/teams/add-member.json | 12 +- .../teams/add-or-update-membership.json | 14 +- .../teams/add-or-update-project.json | 14 +- .../operations/teams/add-or-update-repo.json | 20 +-- .../operations/teams/check-manages-repo.json | 18 +-- .../teams/create-discussion-comment.json | 16 +-- .../operations/teams/create-discussion.json | 16 +-- openapi/ghe-2.17/operations/teams/create.json | 30 ++--- .../teams/delete-discussion-comment.json | 18 +-- .../operations/teams/delete-discussion.json | 12 +- openapi/ghe-2.17/operations/teams/delete.json | 6 +- .../operations/teams/get-by-name.json | 12 +- .../teams/get-discussion-comment.json | 18 +-- .../operations/teams/get-discussion.json | 12 +- .../ghe-2.17/operations/teams/get-member.json | 12 +- .../operations/teams/get-membership.json | 12 +- openapi/ghe-2.17/operations/teams/get.json | 6 +- .../ghe-2.17/operations/teams/list-child.json | 16 +-- .../teams/list-discussion-comments.json | 28 ++-- .../operations/teams/list-discussions.json | 22 ++-- .../teams/list-for-authenticated-user.json | 10 +- .../operations/teams/list-members.json | 22 ++-- .../operations/teams/list-projects.json | 16 +-- .../ghe-2.17/operations/teams/list-repos.json | 16 +-- openapi/ghe-2.17/operations/teams/list.json | 16 +-- .../operations/teams/remove-member.json | 12 +- .../operations/teams/remove-membership.json | 12 +- .../operations/teams/remove-project.json | 12 +- .../operations/teams/remove-repo.json | 18 +-- .../operations/teams/review-project.json | 12 +- .../teams/update-discussion-comment.json | 22 ++-- .../operations/teams/update-discussion.json | 20 +-- openapi/ghe-2.17/operations/teams/update.json | 22 ++-- .../ghe-2.17/operations/users/add-emails.json | 2 +- .../users/check-following-for-user.json | 12 +- .../operations/users/check-following.json | 6 +- .../operations/users/create-gpg-key.json | 4 +- .../operations/users/create-public-key.json | 8 +- .../operations/users/delete-emails.json | 2 +- .../operations/users/delete-gpg-key.json | 6 +- .../operations/users/delete-public-key.json | 6 +- openapi/ghe-2.17/operations/users/follow.json | 6 +- .../operations/users/get-by-username.json | 6 +- .../users/get-context-for-user.json | 18 +-- .../operations/users/get-gpg-key.json | 6 +- .../operations/users/get-public-key.json | 6 +- .../operations/users/list-emails.json | 10 +- ...list-followers-for-authenticated-user.json | 10 +- .../users/list-followers-for-user.json | 16 +-- ...list-following-for-authenticated-user.json | 10 +- .../users/list-following-for-user.json | 16 +-- .../users/list-gpg-keys-for-user.json | 16 +-- .../operations/users/list-gpg-keys.json | 10 +- .../operations/users/list-public-emails.json | 10 +- .../users/list-public-keys-for-user.json | 16 +-- .../operations/users/list-public-keys.json | 10 +- openapi/ghe-2.17/operations/users/list.json | 16 +-- .../ghe-2.17/operations/users/unfollow.json | 6 +- .../users/update-authenticated.json | 28 ++-- 1937 files changed, 17937 insertions(+), 19033 deletions(-) diff --git a/openapi/api.github.com/operations/activity/check-starring-repo.json b/openapi/api.github.com/operations/activity/check-starring-repo.json index 8797e96a57..c08021c2ee 100644 --- a/openapi/api.github.com/operations/activity/check-starring-repo.json +++ b/openapi/api.github.com/operations/activity/check-starring-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/check-watching-repo-legacy.json b/openapi/api.github.com/operations/activity/check-watching-repo-legacy.json index ad7c6e9a9f..c722636ed4 100644 --- a/openapi/api.github.com/operations/activity/check-watching-repo-legacy.json +++ b/openapi/api.github.com/operations/activity/check-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/delete-repo-subscription.json b/openapi/api.github.com/operations/activity/delete-repo-subscription.json index 64bfa03b43..fb6db9089b 100644 --- a/openapi/api.github.com/operations/activity/delete-repo-subscription.json +++ b/openapi/api.github.com/operations/activity/delete-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/delete-thread-subscription.json b/openapi/api.github.com/operations/activity/delete-thread-subscription.json index 80709dde7a..9fa1e8d48f 100644 --- a/openapi/api.github.com/operations/activity/delete-thread-subscription.json +++ b/openapi/api.github.com/operations/activity/delete-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/get-repo-subscription.json b/openapi/api.github.com/operations/activity/get-repo-subscription.json index 0425480277..95b7b77c4b 100644 --- a/openapi/api.github.com/operations/activity/get-repo-subscription.json +++ b/openapi/api.github.com/operations/activity/get-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/get-thread-subscription.json b/openapi/api.github.com/operations/activity/get-thread-subscription.json index b33fc9daa8..c294f59600 100644 --- a/openapi/api.github.com/operations/activity/get-thread-subscription.json +++ b/openapi/api.github.com/operations/activity/get-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/get-thread.json b/openapi/api.github.com/operations/activity/get-thread.json index 82fe80f46b..d3473dc5e2 100644 --- a/openapi/api.github.com/operations/activity/get-thread.json +++ b/openapi/api.github.com/operations/activity/get-thread.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-events-for-org.json b/openapi/api.github.com/operations/activity/list-events-for-org.json index 44da392e66..357746a514 100644 --- a/openapi/api.github.com/operations/activity/list-events-for-org.json +++ b/openapi/api.github.com/operations/activity/list-events-for-org.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-events-for-user.json b/openapi/api.github.com/operations/activity/list-events-for-user.json index ead54ceb54..e0265f7299 100644 --- a/openapi/api.github.com/operations/activity/list-events-for-user.json +++ b/openapi/api.github.com/operations/activity/list-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-notifications-for-repo.json b/openapi/api.github.com/operations/activity/list-notifications-for-repo.json index 64f7172627..6bbc1638b4 100644 --- a/openapi/api.github.com/operations/activity/list-notifications-for-repo.json +++ b/openapi/api.github.com/operations/activity/list-notifications-for-repo.json @@ -21,79 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-notifications.json b/openapi/api.github.com/operations/activity/list-notifications.json index 3532edff50..d311716bd0 100644 --- a/openapi/api.github.com/operations/activity/list-notifications.json +++ b/openapi/api.github.com/operations/activity/list-notifications.json @@ -21,61 +21,59 @@ }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-public-events-for-org.json b/openapi/api.github.com/operations/activity/list-public-events-for-org.json index b6f4161ef1..06e40be947 100644 --- a/openapi/api.github.com/operations/activity/list-public-events-for-org.json +++ b/openapi/api.github.com/operations/activity/list-public-events-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-public-events-for-repo-network.json b/openapi/api.github.com/operations/activity/list-public-events-for-repo-network.json index a0f6425c8d..96b84df64c 100644 --- a/openapi/api.github.com/operations/activity/list-public-events-for-repo-network.json +++ b/openapi/api.github.com/operations/activity/list-public-events-for-repo-network.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-public-events-for-user.json b/openapi/api.github.com/operations/activity/list-public-events-for-user.json index 3c8e0b8d15..afffb87211 100644 --- a/openapi/api.github.com/operations/activity/list-public-events-for-user.json +++ b/openapi/api.github.com/operations/activity/list-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-public-events.json b/openapi/api.github.com/operations/activity/list-public-events.json index dd3bf0eb49..dba43b8821 100644 --- a/openapi/api.github.com/operations/activity/list-public-events.json +++ b/openapi/api.github.com/operations/activity/list-public-events.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-received-events-for-user.json b/openapi/api.github.com/operations/activity/list-received-events-for-user.json index 2dcc3e38f9..88b3c5e0cd 100644 --- a/openapi/api.github.com/operations/activity/list-received-events-for-user.json +++ b/openapi/api.github.com/operations/activity/list-received-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-received-public-events-for-user.json b/openapi/api.github.com/operations/activity/list-received-public-events-for-user.json index 36dc52ebb5..0b0f0238d4 100644 --- a/openapi/api.github.com/operations/activity/list-received-public-events-for-user.json +++ b/openapi/api.github.com/operations/activity/list-received-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-repo-events.json b/openapi/api.github.com/operations/activity/list-repo-events.json index 83d825b129..ec4bddfb71 100644 --- a/openapi/api.github.com/operations/activity/list-repo-events.json +++ b/openapi/api.github.com/operations/activity/list-repo-events.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-repos-starred-by-authenticated-user.json b/openapi/api.github.com/operations/activity/list-repos-starred-by-authenticated-user.json index 828ed472cb..f2a3ebfc91 100644 --- a/openapi/api.github.com/operations/activity/list-repos-starred-by-authenticated-user.json +++ b/openapi/api.github.com/operations/activity/list-repos-starred-by-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -29,13 +31,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -43,29 +45,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-repos-starred-by-user.json b/openapi/api.github.com/operations/activity/list-repos-starred-by-user.json index 04df43b35f..88e41960c9 100644 --- a/openapi/api.github.com/operations/activity/list-repos-starred-by-user.json +++ b/openapi/api.github.com/operations/activity/list-repos-starred-by-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-repos-watched-by-user.json b/openapi/api.github.com/operations/activity/list-repos-watched-by-user.json index e4cf7b376e..25402b4b0e 100644 --- a/openapi/api.github.com/operations/activity/list-repos-watched-by-user.json +++ b/openapi/api.github.com/operations/activity/list-repos-watched-by-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-stargazers-for-repo.json b/openapi/api.github.com/operations/activity/list-stargazers-for-repo.json index 444de01431..fe1adc68e3 100644 --- a/openapi/api.github.com/operations/activity/list-stargazers-for-repo.json +++ b/openapi/api.github.com/operations/activity/list-stargazers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-watched-repos-for-authenticated-user.json b/openapi/api.github.com/operations/activity/list-watched-repos-for-authenticated-user.json index 573f19a243..a28171669c 100644 --- a/openapi/api.github.com/operations/activity/list-watched-repos-for-authenticated-user.json +++ b/openapi/api.github.com/operations/activity/list-watched-repos-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/list-watchers-for-repo.json b/openapi/api.github.com/operations/activity/list-watchers-for-repo.json index c961a3908e..394b0ffb66 100644 --- a/openapi/api.github.com/operations/activity/list-watchers-for-repo.json +++ b/openapi/api.github.com/operations/activity/list-watchers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/mark-as-read.json b/openapi/api.github.com/operations/activity/mark-as-read.json index 65a8c835bd..9aff034697 100644 --- a/openapi/api.github.com/operations/activity/mark-as-read.json +++ b/openapi/api.github.com/operations/activity/mark-as-read.json @@ -48,8 +48,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/api.github.com/operations/activity/mark-notifications-as-read-for-repo.json b/openapi/api.github.com/operations/activity/mark-notifications-as-read-for-repo.json index f2f7581414..18df2327d3 100644 --- a/openapi/api.github.com/operations/activity/mark-notifications-as-read-for-repo.json +++ b/openapi/api.github.com/operations/activity/mark-notifications-as-read-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/api.github.com/operations/activity/mark-thread-as-read.json b/openapi/api.github.com/operations/activity/mark-thread-as-read.json index 27b72afd24..bf74c41a18 100644 --- a/openapi/api.github.com/operations/activity/mark-thread-as-read.json +++ b/openapi/api.github.com/operations/activity/mark-thread-as-read.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/set-repo-subscription.json b/openapi/api.github.com/operations/activity/set-repo-subscription.json index 4e20c3ae99..965af4cc90 100644 --- a/openapi/api.github.com/operations/activity/set-repo-subscription.json +++ b/openapi/api.github.com/operations/activity/set-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -93,12 +93,12 @@ "type": "object", "properties": { "subscribed": { - "description": "Determines if notifications should be received from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if notifications should be received from this repository." }, "ignored": { - "description": "Determines if all notifications should be blocked from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if all notifications should be blocked from this repository." } } } diff --git a/openapi/api.github.com/operations/activity/set-thread-subscription.json b/openapi/api.github.com/operations/activity/set-thread-subscription.json index 378d53226b..73b1419d69 100644 --- a/openapi/api.github.com/operations/activity/set-thread-subscription.json +++ b/openapi/api.github.com/operations/activity/set-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { @@ -84,8 +84,8 @@ "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", + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", "default": false } } diff --git a/openapi/api.github.com/operations/activity/star-repo.json b/openapi/api.github.com/operations/activity/star-repo.json index 3485cf25e8..5c894c6cc5 100644 --- a/openapi/api.github.com/operations/activity/star-repo.json +++ b/openapi/api.github.com/operations/activity/star-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/stop-watching-repo-legacy.json b/openapi/api.github.com/operations/activity/stop-watching-repo-legacy.json index cc963a70db..ac885f9090 100644 --- a/openapi/api.github.com/operations/activity/stop-watching-repo-legacy.json +++ b/openapi/api.github.com/operations/activity/stop-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/unstar-repo.json b/openapi/api.github.com/operations/activity/unstar-repo.json index 9c84a7237b..4c16756eec 100644 --- a/openapi/api.github.com/operations/activity/unstar-repo.json +++ b/openapi/api.github.com/operations/activity/unstar-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/activity/watch-repo-legacy.json b/openapi/api.github.com/operations/activity/watch-repo-legacy.json index 899d72dbaa..20e1cff825 100644 --- a/openapi/api.github.com/operations/activity/watch-repo-legacy.json +++ b/openapi/api.github.com/operations/activity/watch-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/add-repo-to-installation.json b/openapi/api.github.com/operations/apps/add-repo-to-installation.json index 969a80747c..1b651fd8b1 100644 --- a/openapi/api.github.com/operations/apps/add-repo-to-installation.json +++ b/openapi/api.github.com/operations/apps/add-repo-to-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/check-account-is-associated-with-any-stubbed.json b/openapi/api.github.com/operations/apps/check-account-is-associated-with-any-stubbed.json index 6ffd4c5e9e..007bb000c3 100644 --- a/openapi/api.github.com/operations/apps/check-account-is-associated-with-any-stubbed.json +++ b/openapi/api.github.com/operations/apps/check-account-is-associated-with-any-stubbed.json @@ -21,32 +21,30 @@ }, { "name": "account_id", + "description": "account_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "account_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/check-account-is-associated-with-any.json b/openapi/api.github.com/operations/apps/check-account-is-associated-with-any.json index fb758b4b96..2de93cee24 100644 --- a/openapi/api.github.com/operations/apps/check-account-is-associated-with-any.json +++ b/openapi/api.github.com/operations/apps/check-account-is-associated-with-any.json @@ -21,32 +21,30 @@ }, { "name": "account_id", + "description": "account_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "account_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/create-content-attachment.json b/openapi/api.github.com/operations/apps/create-content-attachment.json index f0d769abd5..718a66f592 100644 --- a/openapi/api.github.com/operations/apps/create-content-attachment.json +++ b/openapi/api.github.com/operations/apps/create-content-attachment.json @@ -22,12 +22,12 @@ }, { "name": "content_reference_id", + "description": "content_reference_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "content_reference_id parameter" + } } ], "responses": { @@ -76,12 +76,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", - "type": "string" + "type": "string", + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request." }, "body": { - "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", - "type": "string" + "type": "string", + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown." } }, "required": [ diff --git a/openapi/api.github.com/operations/apps/create-from-manifest.json b/openapi/api.github.com/operations/apps/create-from-manifest.json index a4a97e2854..24d23925da 100644 --- a/openapi/api.github.com/operations/apps/create-from-manifest.json +++ b/openapi/api.github.com/operations/apps/create-from-manifest.json @@ -22,12 +22,12 @@ }, { "name": "code", + "description": "code parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "code parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/create-installation-token.json b/openapi/api.github.com/operations/apps/create-installation-token.json index 7a382aa6b1..c60a76fbf5 100644 --- a/openapi/api.github.com/operations/apps/create-installation-token.json +++ b/openapi/api.github.com/operations/apps/create-installation-token.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { @@ -396,15 +396,15 @@ "type": "object", "properties": { "repository_ids": { - "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", "type": "array", + "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", "items": { "type": "integer" } }, "permissions": { - "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", "type": "object", + "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", "properties": {} } } diff --git a/openapi/api.github.com/operations/apps/delete-installation.json b/openapi/api.github.com/operations/apps/delete-installation.json index 952c0acb6b..cb18eb0b9d 100644 --- a/openapi/api.github.com/operations/apps/delete-installation.json +++ b/openapi/api.github.com/operations/apps/delete-installation.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/get-by-slug.json b/openapi/api.github.com/operations/apps/get-by-slug.json index 8a35024203..a211deb29a 100644 --- a/openapi/api.github.com/operations/apps/get-by-slug.json +++ b/openapi/api.github.com/operations/apps/get-by-slug.json @@ -22,12 +22,12 @@ }, { "name": "app_slug", + "description": "app_slug parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "app_slug parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/get-installation.json b/openapi/api.github.com/operations/apps/get-installation.json index d018e96185..5dc2877101 100644 --- a/openapi/api.github.com/operations/apps/get-installation.json +++ b/openapi/api.github.com/operations/apps/get-installation.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/get-org-installation.json b/openapi/api.github.com/operations/apps/get-org-installation.json index aa19c4c79a..35bfc9dc18 100644 --- a/openapi/api.github.com/operations/apps/get-org-installation.json +++ b/openapi/api.github.com/operations/apps/get-org-installation.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/get-repo-installation.json b/openapi/api.github.com/operations/apps/get-repo-installation.json index 1a1fcc4de4..72249dc1e7 100644 --- a/openapi/api.github.com/operations/apps/get-repo-installation.json +++ b/openapi/api.github.com/operations/apps/get-repo-installation.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/get-user-installation.json b/openapi/api.github.com/operations/apps/get-user-installation.json index d865eaa463..89cc6c9b52 100644 --- a/openapi/api.github.com/operations/apps/get-user-installation.json +++ b/openapi/api.github.com/operations/apps/get-user-installation.json @@ -22,12 +22,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan-stubbed.json b/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan-stubbed.json index cdd63eb476..243cf17010 100644 --- a/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan-stubbed.json +++ b/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan-stubbed.json @@ -21,16 +21,18 @@ }, { "name": "plan_id", + "description": "plan_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "plan_id parameter" + } }, { "name": "sort", + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,42 +40,38 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`." + } }, { "name": "direction", + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan.json b/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan.json index aa9db84c0b..878c3d0ef7 100644 --- a/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan.json +++ b/openapi/api.github.com/operations/apps/list-accounts-user-or-org-on-plan.json @@ -21,16 +21,18 @@ }, { "name": "plan_id", + "description": "plan_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "plan_id parameter" + } }, { "name": "sort", + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,42 +40,38 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`." + } }, { "name": "direction", + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-installation-repos-for-authenticated-user.json b/openapi/api.github.com/operations/apps/list-installation-repos-for-authenticated-user.json index 52ad7b2e92..2b35e75af6 100644 --- a/openapi/api.github.com/operations/apps/list-installation-repos-for-authenticated-user.json +++ b/openapi/api.github.com/operations/apps/list-installation-repos-for-authenticated-user.json @@ -22,32 +22,30 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-installations-for-authenticated-user.json b/openapi/api.github.com/operations/apps/list-installations-for-authenticated-user.json index ce4841a2fd..d711af5abc 100644 --- a/openapi/api.github.com/operations/apps/list-installations-for-authenticated-user.json +++ b/openapi/api.github.com/operations/apps/list-installations-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-installations.json b/openapi/api.github.com/operations/apps/list-installations.json index 644edeb8b8..8c4be23850 100644 --- a/openapi/api.github.com/operations/apps/list-installations.json +++ b/openapi/api.github.com/operations/apps/list-installations.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user-stubbed.json b/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user-stubbed.json index 9eb965a790..761d69350f 100644 --- a/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user-stubbed.json +++ b/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user-stubbed.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user.json b/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user.json index 538195b481..f4050daf6e 100644 --- a/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user.json +++ b/openapi/api.github.com/operations/apps/list-marketplace-purchases-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-plans-stubbed.json b/openapi/api.github.com/operations/apps/list-plans-stubbed.json index 36705cfb83..738dce65ca 100644 --- a/openapi/api.github.com/operations/apps/list-plans-stubbed.json +++ b/openapi/api.github.com/operations/apps/list-plans-stubbed.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-plans.json b/openapi/api.github.com/operations/apps/list-plans.json index d13b715f97..a7f6b00df4 100644 --- a/openapi/api.github.com/operations/apps/list-plans.json +++ b/openapi/api.github.com/operations/apps/list-plans.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/list-repos.json b/openapi/api.github.com/operations/apps/list-repos.json index 4dc017e400..9ba89fe585 100644 --- a/openapi/api.github.com/operations/apps/list-repos.json +++ b/openapi/api.github.com/operations/apps/list-repos.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/apps/remove-repo-from-installation.json b/openapi/api.github.com/operations/apps/remove-repo-from-installation.json index f2138a0483..53e9686b3c 100644 --- a/openapi/api.github.com/operations/apps/remove-repo-from-installation.json +++ b/openapi/api.github.com/operations/apps/remove-repo-from-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/create-suite.json b/openapi/api.github.com/operations/checks/create-suite.json index 7b52015462..0515ba6e08 100644 --- a/openapi/api.github.com/operations/checks/create-suite.json +++ b/openapi/api.github.com/operations/checks/create-suite.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -486,8 +486,8 @@ "type": "object", "properties": { "head_sha": { - "description": "The sha of the head commit.", - "type": "string" + "type": "string", + "description": "The sha of the head commit." } }, "required": [ diff --git a/openapi/api.github.com/operations/checks/create.json b/openapi/api.github.com/operations/checks/create.json index c86ccaad17..617638740b 100644 --- a/openapi/api.github.com/operations/checks/create.json +++ b/openapi/api.github.com/operations/checks/create.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -271,24 +271,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "head_sha": { - "description": "The SHA of the commit.", - "type": "string" + "type": "string", + "description": "The SHA of the commit." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -297,12 +297,12 @@ "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" + "type": "string", + "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`." }, "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", + "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`.", "enum": [ "success", "failure", @@ -313,54 +313,54 @@ ] }, "completed_at": { - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string" + "type": "string", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, "output": { - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", "type": "object", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", "properties": { "title": { - "description": "The title of the check run.", - "type": "string" + "type": "string", + "description": "The title of the check run." }, "summary": { - "description": "The summary of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The summary of the check run. This parameter supports Markdown." }, "text": { - "description": "The details of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The details of the check run. This parameter supports Markdown." }, "annotations": { - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "type": "array", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -368,16 +368,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -390,22 +390,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -421,22 +421,22 @@ ] }, "actions": { - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/api.github.com/operations/checks/get-suite.json b/openapi/api.github.com/operations/checks/get-suite.json index 6eb1fc00f1..2b30035866 100644 --- a/openapi/api.github.com/operations/checks/get-suite.json +++ b/openapi/api.github.com/operations/checks/get-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/get.json b/openapi/api.github.com/operations/checks/get.json index d8b25efd82..7d3297616c 100644 --- a/openapi/api.github.com/operations/checks/get.json +++ b/openapi/api.github.com/operations/checks/get.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/list-annotations.json b/openapi/api.github.com/operations/checks/list-annotations.json index 378b068d0f..829fa7b361 100644 --- a/openapi/api.github.com/operations/checks/list-annotations.json +++ b/openapi/api.github.com/operations/checks/list-annotations.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/list-for-ref.json b/openapi/api.github.com/operations/checks/list-for-ref.json index 3fb35f11d0..d3f2d83f49 100644 --- a/openapi/api.github.com/operations/checks/list-for-ref.json +++ b/openapi/api.github.com/operations/checks/list-for-ref.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/list-for-suite.json b/openapi/api.github.com/operations/checks/list-for-suite.json index 05a18f9f32..56454d5b05 100644 --- a/openapi/api.github.com/operations/checks/list-for-suite.json +++ b/openapi/api.github.com/operations/checks/list-for-suite.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/list-suites-for-ref.json b/openapi/api.github.com/operations/checks/list-suites-for-ref.json index b282bbaede..aeb8ff341b 100644 --- a/openapi/api.github.com/operations/checks/list-suites-for-ref.json +++ b/openapi/api.github.com/operations/checks/list-suites-for-ref.json @@ -22,68 +22,66 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", "in": "query", + "required": false, "schema": { "type": "integer" - }, - "required": false, - "description": "Filters check suites by GitHub App `id`." + } }, { "name": "check_name", + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/rerequest-suite.json b/openapi/api.github.com/operations/checks/rerequest-suite.json index 0fd063ca9e..7b79c842a8 100644 --- a/openapi/api.github.com/operations/checks/rerequest-suite.json +++ b/openapi/api.github.com/operations/checks/rerequest-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/checks/set-suites-preferences.json b/openapi/api.github.com/operations/checks/set-suites-preferences.json index 8499b1aae8..042bda8460 100644 --- a/openapi/api.github.com/operations/checks/set-suites-preferences.json +++ b/openapi/api.github.com/operations/checks/set-suites-preferences.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -408,18 +408,18 @@ "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/v3/checks/suites/#auto_trigger_checks-object) description for details.", "type": "array", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", "items": { "type": "object", "properties": { "app_id": { - "description": "The `id` of the GitHub App.", - "type": "integer" + "type": "integer", + "description": "The `id` of the GitHub App." }, "setting": { - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "type": "boolean", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "default": true } }, diff --git a/openapi/api.github.com/operations/checks/update.json b/openapi/api.github.com/operations/checks/update.json index 3cd7238cb6..49db072e03 100644 --- a/openapi/api.github.com/operations/checks/update.json +++ b/openapi/api.github.com/operations/checks/update.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { @@ -286,24 +286,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "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" + "type": "string", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -311,8 +311,8 @@ ] }, "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", + "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`.", "enum": [ "success", "failure", @@ -323,54 +323,54 @@ ] }, "completed_at": { - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "type": "string" + "type": "string", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, "output": { - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", "type": "object", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", "properties": { "title": { - "description": "**Required**.", - "type": "string" + "type": "string", + "description": "**Required**." }, "summary": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "text": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "annotations": { - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -378,16 +378,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -400,22 +400,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -430,22 +430,22 @@ ] }, "actions": { - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/api.github.com/operations/codes-of-conduct/get-conduct-code.json b/openapi/api.github.com/operations/codes-of-conduct/get-conduct-code.json index b6450756a2..5edda35fbf 100644 --- a/openapi/api.github.com/operations/codes-of-conduct/get-conduct-code.json +++ b/openapi/api.github.com/operations/codes-of-conduct/get-conduct-code.json @@ -22,12 +22,12 @@ }, { "name": "key", + "description": "key parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/codes-of-conduct/get-for-repo.json b/openapi/api.github.com/operations/codes-of-conduct/get-for-repo.json index e466ce1f36..b1d464ac5d 100644 --- a/openapi/api.github.com/operations/codes-of-conduct/get-for-repo.json +++ b/openapi/api.github.com/operations/codes-of-conduct/get-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/check-is-starred.json b/openapi/api.github.com/operations/gists/check-is-starred.json index 2cf30e6ddf..81a28d262d 100644 --- a/openapi/api.github.com/operations/gists/check-is-starred.json +++ b/openapi/api.github.com/operations/gists/check-is-starred.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/create-comment.json b/openapi/api.github.com/operations/gists/create-comment.json index a2477766e4..1eb941bdc4 100644 --- a/openapi/api.github.com/operations/gists/create-comment.json +++ b/openapi/api.github.com/operations/gists/create-comment.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -143,8 +143,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/api.github.com/operations/gists/create.json b/openapi/api.github.com/operations/gists/create.json index 9586fcaf6f..e8917760ca 100644 --- a/openapi/api.github.com/operations/gists/create.json +++ b/openapi/api.github.com/operations/gists/create.json @@ -442,22 +442,22 @@ "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", + "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`.", "properties": { "content": { - "description": "The content of the file.", - "type": "string" + "type": "string", + "description": "The content of the file." } } }, "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "public": { - "description": "When `true`, the gist will be public and available for anyone to see.", "type": "boolean", + "description": "When `true`, the gist will be public and available for anyone to see.", "default": false } }, diff --git a/openapi/api.github.com/operations/gists/delete-comment.json b/openapi/api.github.com/operations/gists/delete-comment.json index 678004a69e..8baf7e60b8 100644 --- a/openapi/api.github.com/operations/gists/delete-comment.json +++ b/openapi/api.github.com/operations/gists/delete-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/delete.json b/openapi/api.github.com/operations/gists/delete.json index 876d47e395..a89c77cf19 100644 --- a/openapi/api.github.com/operations/gists/delete.json +++ b/openapi/api.github.com/operations/gists/delete.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/fork.json b/openapi/api.github.com/operations/gists/fork.json index 85a520f856..4a8a60bad3 100644 --- a/openapi/api.github.com/operations/gists/fork.json +++ b/openapi/api.github.com/operations/gists/fork.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/get-comment.json b/openapi/api.github.com/operations/gists/get-comment.json index 3958975d51..f38c8f25a2 100644 --- a/openapi/api.github.com/operations/gists/get-comment.json +++ b/openapi/api.github.com/operations/gists/get-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/get-revision.json b/openapi/api.github.com/operations/gists/get-revision.json index 4f023aa34b..0c5ed055cf 100644 --- a/openapi/api.github.com/operations/gists/get-revision.json +++ b/openapi/api.github.com/operations/gists/get-revision.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/get.json b/openapi/api.github.com/operations/gists/get.json index 36b39cabeb..05e4c61f31 100644 --- a/openapi/api.github.com/operations/gists/get.json +++ b/openapi/api.github.com/operations/gists/get.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list-comments.json b/openapi/api.github.com/operations/gists/list-comments.json index a68e40681b..edb7a2dc18 100644 --- a/openapi/api.github.com/operations/gists/list-comments.json +++ b/openapi/api.github.com/operations/gists/list-comments.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list-commits.json b/openapi/api.github.com/operations/gists/list-commits.json index 36c37f6048..7143b1605c 100644 --- a/openapi/api.github.com/operations/gists/list-commits.json +++ b/openapi/api.github.com/operations/gists/list-commits.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list-forks.json b/openapi/api.github.com/operations/gists/list-forks.json index 59c35b84e0..339206b332 100644 --- a/openapi/api.github.com/operations/gists/list-forks.json +++ b/openapi/api.github.com/operations/gists/list-forks.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list-public-for-user.json b/openapi/api.github.com/operations/gists/list-public-for-user.json index 2cfe4d8b28..603385e019 100644 --- a/openapi/api.github.com/operations/gists/list-public-for-user.json +++ b/openapi/api.github.com/operations/gists/list-public-for-user.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list-public.json b/openapi/api.github.com/operations/gists/list-public.json index 8fe65a4da9..4d8248a56e 100644 --- a/openapi/api.github.com/operations/gists/list-public.json +++ b/openapi/api.github.com/operations/gists/list-public.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list-starred.json b/openapi/api.github.com/operations/gists/list-starred.json index 3c97c8ee4e..2df0943ebd 100644 --- a/openapi/api.github.com/operations/gists/list-starred.json +++ b/openapi/api.github.com/operations/gists/list-starred.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/list.json b/openapi/api.github.com/operations/gists/list.json index 083bb7585f..5ca5adbe43 100644 --- a/openapi/api.github.com/operations/gists/list.json +++ b/openapi/api.github.com/operations/gists/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/star.json b/openapi/api.github.com/operations/gists/star.json index 5b6de0c2e8..ca1e97cdb4 100644 --- a/openapi/api.github.com/operations/gists/star.json +++ b/openapi/api.github.com/operations/gists/star.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/unstar.json b/openapi/api.github.com/operations/gists/unstar.json index 0daa9927f1..f93b1e7d4c 100644 --- a/openapi/api.github.com/operations/gists/unstar.json +++ b/openapi/api.github.com/operations/gists/unstar.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/gists/update-comment.json b/openapi/api.github.com/operations/gists/update-comment.json index 8cedd5396c..c686e44dbd 100644 --- a/openapi/api.github.com/operations/gists/update-comment.json +++ b/openapi/api.github.com/operations/gists/update-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -152,8 +152,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/api.github.com/operations/gists/update.json b/openapi/api.github.com/operations/gists/update.json index a53f05e673..684c91055f 100644 --- a/openapi/api.github.com/operations/gists/update.json +++ b/openapi/api.github.com/operations/gists/update.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -451,20 +451,20 @@ "type": "object", "properties": { "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "files": { - "description": "The filenames and content that make up this gist.", "type": "object", + "description": "The filenames and content that make up this gist.", "properties": { "content": { - "description": "The updated content of the file.", - "type": "string" + "type": "string", + "description": "The updated content of the file." }, "filename": { - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "type": "string" + "type": "string", + "description": "The new name for this file. To delete a file, set the value of the filename to `null`." } } } diff --git a/openapi/api.github.com/operations/git/create-blob.json b/openapi/api.github.com/operations/git/create-blob.json index bfc8e3f0e3..34f15144b7 100644 --- a/openapi/api.github.com/operations/git/create-blob.json +++ b/openapi/api.github.com/operations/git/create-blob.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,12 +81,12 @@ "type": "object", "properties": { "content": { - "description": "The new blob's content.", - "type": "string" + "type": "string", + "description": "The new blob's content." }, "encoding": { - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } }, diff --git a/openapi/api.github.com/operations/git/create-commit.json b/openapi/api.github.com/operations/git/create-commit.json index 23855f3aed..64b15cdce6 100644 --- a/openapi/api.github.com/operations/git/create-commit.json +++ b/openapi/api.github.com/operations/git/create-commit.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -157,59 +157,59 @@ "type": "object", "properties": { "message": { - "description": "The commit message", - "type": "string" + "type": "string", + "description": "The commit message" }, "tree": { - "description": "The SHA of the tree object this commit points to", - "type": "string" + "type": "string", + "description": "The SHA of the tree object this commit points to" }, "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", + "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.", "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/api.github.com/operations/git/create-ref.json b/openapi/api.github.com/operations/git/create-ref.json index 8323594dbe..adc5fa290f 100644 --- a/openapi/api.github.com/operations/git/create-ref.json +++ b/openapi/api.github.com/operations/git/create-ref.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -98,12 +98,12 @@ "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" + "type": "string", + "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." }, "sha": { - "description": "The SHA1 value for this reference.", - "type": "string" + "type": "string", + "description": "The SHA1 value for this reference." } }, "required": [ diff --git a/openapi/api.github.com/operations/git/create-tag.json b/openapi/api.github.com/operations/git/create-tag.json index 398bffe5d7..4dba4c80b1 100644 --- a/openapi/api.github.com/operations/git/create-tag.json +++ b/openapi/api.github.com/operations/git/create-tag.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -135,20 +135,20 @@ "type": "object", "properties": { "tag": { - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "type": "string" + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." }, "message": { - "description": "The tag message.", - "type": "string" + "type": "string", + "description": "The tag message." }, "object": { - "description": "The SHA of the git object this is tagging.", - "type": "string" + "type": "string", + "description": "The SHA of the git object this is tagging." }, "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", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", "enum": [ "commit", "tree", @@ -156,20 +156,20 @@ ] }, "tagger": { - "description": "An object with information about the individual creating the tag.", "type": "object", + "description": "An object with information about the individual creating the tag.", "properties": { "name": { - "description": "The name of the author of the tag", - "type": "string" + "type": "string", + "description": "The name of the author of the tag" }, "email": { - "description": "The email of the author of the tag", - "type": "string" + "type": "string", + "description": "The email of the author of the tag" }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/api.github.com/operations/git/create-tree.json b/openapi/api.github.com/operations/git/create-tree.json index 5a52cfd66f..4382516b62 100644 --- a/openapi/api.github.com/operations/git/create-tree.json +++ b/openapi/api.github.com/operations/git/create-tree.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -107,18 +107,18 @@ "type": "object", "properties": { "tree": { - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "items": { "type": "object", "properties": { "path": { - "description": "The file referenced in the tree.", - "type": "string" + "type": "string", + "description": "The file referenced in the tree." }, "mode": { - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", "type": "string", + "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.", "enum": [ "100644", "100755", @@ -128,8 +128,8 @@ ] }, "type": { - "description": "Either `blob`, `tree`, or `commit`.", "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", "enum": [ "blob", "tree", @@ -137,19 +137,19 @@ ] }, "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" + "type": "string", + "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." }, "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" + "type": "string", + "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." } } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/api.github.com/operations/git/delete-ref.json b/openapi/api.github.com/operations/git/delete-ref.json index 9916f857d5..a0f2dfe831 100644 --- a/openapi/api.github.com/operations/git/delete-ref.json +++ b/openapi/api.github.com/operations/git/delete-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/git/get-blob.json b/openapi/api.github.com/operations/git/get-blob.json index f3fc897c3a..e6b416867b 100644 --- a/openapi/api.github.com/operations/git/get-blob.json +++ b/openapi/api.github.com/operations/git/get-blob.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "file_sha", + "description": "file_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "file_sha parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/git/get-commit.json b/openapi/api.github.com/operations/git/get-commit.json index 5e29375610..084bae8fa2 100644 --- a/openapi/api.github.com/operations/git/get-commit.json +++ b/openapi/api.github.com/operations/git/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/git/get-tag.json b/openapi/api.github.com/operations/git/get-tag.json index 6f1ca346aa..4d77b45f4c 100644 --- a/openapi/api.github.com/operations/git/get-tag.json +++ b/openapi/api.github.com/operations/git/get-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag_sha", + "description": "tag_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag_sha parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/git/get-tree.json b/openapi/api.github.com/operations/git/get-tree.json index fe40e446f2..bc6a503566 100644 --- a/openapi/api.github.com/operations/git/get-tree.json +++ b/openapi/api.github.com/operations/git/get-tree.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-tree", "tags": [ "git" ], @@ -21,41 +21,41 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tree_sha", + "description": "tree_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tree_sha parameter" + } }, { "name": "recursive", + "description": "recursive parameter", "in": "query", "schema": { "type": "integer", "enum": [ 1 ] - }, - "description": "recursive parameter" + } } ], "responses": { @@ -70,7 +70,7 @@ }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" + "source": "octokit.git.getTree({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" } ], "x-github": { diff --git a/openapi/api.github.com/operations/git/update-ref.json b/openapi/api.github.com/operations/git/update-ref.json index 7606305fec..b8ecdb65a0 100644 --- a/openapi/api.github.com/operations/git/update-ref.json +++ b/openapi/api.github.com/operations/git/update-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "sha": { - "description": "The SHA1 value to set this reference to", - "type": "string" + "type": "string", + "description": "The SHA1 value to set this reference to" }, "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", + "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.", "default": false } }, diff --git a/openapi/api.github.com/operations/gitignore/get-template.json b/openapi/api.github.com/operations/gitignore/get-template.json index b74a581fda..93ac441ff0 100644 --- a/openapi/api.github.com/operations/gitignore/get-template.json +++ b/openapi/api.github.com/operations/gitignore/get-template.json @@ -21,12 +21,12 @@ }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-org.json b/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-org.json index aa759195d7..69762a1162 100644 --- a/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-org.json +++ b/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-org.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -76,8 +76,8 @@ "type": "object", "properties": { "limit": { - "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", "type": "string", + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", "enum": [ "existing_users", "contributors_only", diff --git a/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-repo.json b/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-repo.json index a502f08f6a..bad8fad38d 100644 --- a/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-repo.json +++ b/openapi/api.github.com/operations/interactions/add-or-update-restrictions-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -85,8 +85,8 @@ "type": "object", "properties": { "limit": { - "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", "type": "string", + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", "enum": [ "existing_users", "contributors_only", diff --git a/openapi/api.github.com/operations/interactions/get-restrictions-for-org.json b/openapi/api.github.com/operations/interactions/get-restrictions-for-org.json index d18aa8e5fc..2b01e2962c 100644 --- a/openapi/api.github.com/operations/interactions/get-restrictions-for-org.json +++ b/openapi/api.github.com/operations/interactions/get-restrictions-for-org.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/interactions/get-restrictions-for-repo.json b/openapi/api.github.com/operations/interactions/get-restrictions-for-repo.json index 4e6c03c242..7021d91d18 100644 --- a/openapi/api.github.com/operations/interactions/get-restrictions-for-repo.json +++ b/openapi/api.github.com/operations/interactions/get-restrictions-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/interactions/remove-restrictions-for-org.json b/openapi/api.github.com/operations/interactions/remove-restrictions-for-org.json index ae3fbe46a2..4fb9e69133 100644 --- a/openapi/api.github.com/operations/interactions/remove-restrictions-for-org.json +++ b/openapi/api.github.com/operations/interactions/remove-restrictions-for-org.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/interactions/remove-restrictions-for-repo.json b/openapi/api.github.com/operations/interactions/remove-restrictions-for-repo.json index 8036fa429c..9552f6d42a 100644 --- a/openapi/api.github.com/operations/interactions/remove-restrictions-for-repo.json +++ b/openapi/api.github.com/operations/interactions/remove-restrictions-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/add-assignees.json b/openapi/api.github.com/operations/issues/add-assignees.json index d51bfb6159..3b8f2ad159 100644 --- a/openapi/api.github.com/operations/issues/add-assignees.json +++ b/openapi/api.github.com/operations/issues/add-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -503,8 +503,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/issues/add-labels.json b/openapi/api.github.com/operations/issues/add-labels.json index 26bffc5f30..83231cb5ce 100644 --- a/openapi/api.github.com/operations/issues/add-labels.json +++ b/openapi/api.github.com/operations/issues/add-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -118,8 +118,8 @@ "type": "object", "properties": { "labels": { - "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "type": "array", + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/issues/check-assignee.json b/openapi/api.github.com/operations/issues/check-assignee.json index f4a4b6dda7..1ec7755947 100644 --- a/openapi/api.github.com/operations/issues/check-assignee.json +++ b/openapi/api.github.com/operations/issues/check-assignee.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "assignee", + "description": "assignee parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "assignee parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/create-comment.json b/openapi/api.github.com/operations/issues/create-comment.json index a965d0ada3..b64b93167b 100644 --- a/openapi/api.github.com/operations/issues/create-comment.json +++ b/openapi/api.github.com/operations/issues/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -175,8 +175,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/api.github.com/operations/issues/create-label.json b/openapi/api.github.com/operations/issues/create-label.json index 8e26192528..2c91e2571a 100644 --- a/openapi/api.github.com/operations/issues/create-label.json +++ b/openapi/api.github.com/operations/issues/create-label.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "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" + "type": "string", + "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/)." }, "color": { - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "type": "string" + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." }, "description": { - "description": "A short description of the label.", - "type": "string" + "type": "string", + "description": "A short description of the label." } }, "required": [ diff --git a/openapi/api.github.com/operations/issues/create-milestone.json b/openapi/api.github.com/operations/issues/create-milestone.json index 0cfd484b89..a5c5c0c600 100644 --- a/openapi/api.github.com/operations/issues/create-milestone.json +++ b/openapi/api.github.com/operations/issues/create-milestone.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -192,12 +192,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } }, "required": [ diff --git a/openapi/api.github.com/operations/issues/create.json b/openapi/api.github.com/operations/issues/create.json index 2f6927bb53..c8d723c1f9 100644 --- a/openapi/api.github.com/operations/issues/create.json +++ b/openapi/api.github.com/operations/issues/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -524,31 +524,31 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "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" + "type": "string", + "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.**_" }, "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" + "type": "integer", + "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._" }, "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", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/issues/delete-comment.json b/openapi/api.github.com/operations/issues/delete-comment.json index bcb8f85e16..3fb3eacf02 100644 --- a/openapi/api.github.com/operations/issues/delete-comment.json +++ b/openapi/api.github.com/operations/issues/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/delete-label.json b/openapi/api.github.com/operations/issues/delete-label.json index 93112ac8b2..7378baad78 100644 --- a/openapi/api.github.com/operations/issues/delete-label.json +++ b/openapi/api.github.com/operations/issues/delete-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/delete-milestone.json b/openapi/api.github.com/operations/issues/delete-milestone.json index 8e6d590540..c7aa9b66ca 100644 --- a/openapi/api.github.com/operations/issues/delete-milestone.json +++ b/openapi/api.github.com/operations/issues/delete-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/get-comment.json b/openapi/api.github.com/operations/issues/get-comment.json index a8d8253a63..9acb2429a6 100644 --- a/openapi/api.github.com/operations/issues/get-comment.json +++ b/openapi/api.github.com/operations/issues/get-comment.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/get-event.json b/openapi/api.github.com/operations/issues/get-event.json index 133760ea11..88b8d95988 100644 --- a/openapi/api.github.com/operations/issues/get-event.json +++ b/openapi/api.github.com/operations/issues/get-event.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "event_id", + "description": "event_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "event_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/get-label.json b/openapi/api.github.com/operations/issues/get-label.json index 3371d63f49..cb5a64f852 100644 --- a/openapi/api.github.com/operations/issues/get-label.json +++ b/openapi/api.github.com/operations/issues/get-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/get-milestone.json b/openapi/api.github.com/operations/issues/get-milestone.json index 16fb07d792..b55a7e3991 100644 --- a/openapi/api.github.com/operations/issues/get-milestone.json +++ b/openapi/api.github.com/operations/issues/get-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/get.json b/openapi/api.github.com/operations/issues/get.json index d83f79ad8c..4fcbc22b5d 100644 --- a/openapi/api.github.com/operations/issues/get.json +++ b/openapi/api.github.com/operations/issues/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-assignees.json b/openapi/api.github.com/operations/issues/list-assignees.json index 7323cdf488..cf88f9bade 100644 --- a/openapi/api.github.com/operations/issues/list-assignees.json +++ b/openapi/api.github.com/operations/issues/list-assignees.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-comments-for-repo.json b/openapi/api.github.com/operations/issues/list-comments-for-repo.json index 2798b0d2b7..fc8287e679 100644 --- a/openapi/api.github.com/operations/issues/list-comments-for-repo.json +++ b/openapi/api.github.com/operations/issues/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Either `created` or `updated`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,31 +49,29 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Either `created` or `updated`." + } }, { "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter." + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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": { diff --git a/openapi/api.github.com/operations/issues/list-comments.json b/openapi/api.github.com/operations/issues/list-comments.json index 077276ac33..933e34e798 100644 --- a/openapi/api.github.com/operations/issues/list-comments.json +++ b/openapi/api.github.com/operations/issues/list-comments.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-events-for-repo.json b/openapi/api.github.com/operations/issues/list-events-for-repo.json index c470976aff..572d4bd4df 100644 --- a/openapi/api.github.com/operations/issues/list-events-for-repo.json +++ b/openapi/api.github.com/operations/issues/list-events-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-events-for-timeline.json b/openapi/api.github.com/operations/issues/list-events-for-timeline.json index b7a5f961c5..7cfefd5283 100644 --- a/openapi/api.github.com/operations/issues/list-events-for-timeline.json +++ b/openapi/api.github.com/operations/issues/list-events-for-timeline.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-events.json b/openapi/api.github.com/operations/issues/list-events.json index 2af23f5042..2e0f0d4c29 100644 --- a/openapi/api.github.com/operations/issues/list-events.json +++ b/openapi/api.github.com/operations/issues/list-events.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-for-authenticated-user.json b/openapi/api.github.com/operations/issues/list-for-authenticated-user.json index d4b2aebf10..007742fd46 100644 --- a/openapi/api.github.com/operations/issues/list-for-authenticated-user.json +++ b/openapi/api.github.com/operations/issues/list-for-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-for-org.json b/openapi/api.github.com/operations/issues/list-for-org.json index 799172a2d2..d10845f96b 100644 --- a/openapi/api.github.com/operations/issues/list-for-org.json +++ b/openapi/api.github.com/operations/issues/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -41,13 +43,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,13 +82,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -94,38 +96,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-for-repo.json b/openapi/api.github.com/operations/issues/list-for-repo.json index 751b415974..158cf4c85e 100644 --- a/openapi/api.github.com/operations/issues/list-for-repo.json +++ b/openapi/api.github.com/operations/issues/list-for-repo.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone", + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", "in": "query", + "required": false, "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,49 +59,49 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", "in": "query", + "required": false, "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", + "description": "The user that created the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The user that created the issue." + } }, { "name": "mentioned", + "description": "A user that's mentioned in the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A user that's mentioned in the issue." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -108,13 +110,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -122,38 +124,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-labels-for-milestone.json b/openapi/api.github.com/operations/issues/list-labels-for-milestone.json index e320b642f1..a3b7a9a396 100644 --- a/openapi/api.github.com/operations/issues/list-labels-for-milestone.json +++ b/openapi/api.github.com/operations/issues/list-labels-for-milestone.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-labels-for-repo.json b/openapi/api.github.com/operations/issues/list-labels-for-repo.json index b90d447350..f3be07559b 100644 --- a/openapi/api.github.com/operations/issues/list-labels-for-repo.json +++ b/openapi/api.github.com/operations/issues/list-labels-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-labels-on-issue.json b/openapi/api.github.com/operations/issues/list-labels-on-issue.json index 44efcc1281..c5964d1a9e 100644 --- a/openapi/api.github.com/operations/issues/list-labels-on-issue.json +++ b/openapi/api.github.com/operations/issues/list-labels-on-issue.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list-milestones-for-repo.json b/openapi/api.github.com/operations/issues/list-milestones-for-repo.json index 99ad605a67..a9b6cb18d7 100644 --- a/openapi/api.github.com/operations/issues/list-milestones-for-repo.json +++ b/openapi/api.github.com/operations/issues/list-milestones-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,13 +50,13 @@ "all" ], "default": "open" - }, - "required": false, - "description": "The state of the milestone. Either `open`, `closed`, or `all`." + } }, { "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,13 +64,13 @@ "completeness" ], "default": "due_on" - }, - "required": false, - "description": "What to sort results by. Either `due_on` or `completeness`." + } }, { "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -76,29 +78,25 @@ "desc" ], "default": "asc" - }, - "required": false, - "description": "The direction of the sort. Either `asc` or `desc`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/list.json b/openapi/api.github.com/operations/issues/list.json index 0112b958fd..33f2796e36 100644 --- a/openapi/api.github.com/operations/issues/list.json +++ b/openapi/api.github.com/operations/issues/list.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/lock.json b/openapi/api.github.com/operations/issues/lock.json index f415f42788..ad9455b7d4 100644 --- a/openapi/api.github.com/operations/issues/lock.json +++ b/openapi/api.github.com/operations/issues/lock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -85,8 +85,8 @@ "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", + "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`", "enum": [ "off-topic", "too heated", diff --git a/openapi/api.github.com/operations/issues/remove-assignees.json b/openapi/api.github.com/operations/issues/remove-assignees.json index 938fd9207e..1d0acb24a9 100644 --- a/openapi/api.github.com/operations/issues/remove-assignees.json +++ b/openapi/api.github.com/operations/issues/remove-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -483,8 +483,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/issues/remove-label.json b/openapi/api.github.com/operations/issues/remove-label.json index 24ebb7e56a..bbf5050f10 100644 --- a/openapi/api.github.com/operations/issues/remove-label.json +++ b/openapi/api.github.com/operations/issues/remove-label.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/remove-labels.json b/openapi/api.github.com/operations/issues/remove-labels.json index 51ee47b249..33cdf12da2 100644 --- a/openapi/api.github.com/operations/issues/remove-labels.json +++ b/openapi/api.github.com/operations/issues/remove-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/replace-labels.json b/openapi/api.github.com/operations/issues/replace-labels.json index 1d878fbb0a..0f671c84b9 100644 --- a/openapi/api.github.com/operations/issues/replace-labels.json +++ b/openapi/api.github.com/operations/issues/replace-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -118,8 +118,8 @@ "type": "object", "properties": { "labels": { - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "type": "array", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/issues/unlock.json b/openapi/api.github.com/operations/issues/unlock.json index fc4dcb6ddc..40aa75f073 100644 --- a/openapi/api.github.com/operations/issues/unlock.json +++ b/openapi/api.github.com/operations/issues/unlock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/issues/update-comment.json b/openapi/api.github.com/operations/issues/update-comment.json index 4f06aae7b9..4087776c5a 100644 --- a/openapi/api.github.com/operations/issues/update-comment.json +++ b/openapi/api.github.com/operations/issues/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -164,8 +164,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/api.github.com/operations/issues/update-milestone.json b/openapi/api.github.com/operations/issues/update-milestone.json index 57974c900d..62d87a0c61 100644 --- a/openapi/api.github.com/operations/issues/update-milestone.json +++ b/openapi/api.github.com/operations/issues/update-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { @@ -198,12 +198,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -211,12 +211,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/api.github.com/operations/issues/update.json b/openapi/api.github.com/operations/issues/update.json index e545663899..1a4063bd5b 100644 --- a/openapi/api.github.com/operations/issues/update.json +++ b/openapi/api.github.com/operations/issues/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -542,40 +542,40 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "assignee": { - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "type": "string" + "type": "string", + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**" }, "state": { - "description": "State of the issue. Either `open` or `closed`.", "type": "string", + "description": "State of the issue. Either `open` or `closed`.", "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", + "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._", "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", + "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._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/licenses/get-for-repo.json b/openapi/api.github.com/operations/licenses/get-for-repo.json index 1d9f81007f..b08669014d 100644 --- a/openapi/api.github.com/operations/licenses/get-for-repo.json +++ b/openapi/api.github.com/operations/licenses/get-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/licenses/get.json b/openapi/api.github.com/operations/licenses/get.json index 3409970999..785bc272bf 100644 --- a/openapi/api.github.com/operations/licenses/get.json +++ b/openapi/api.github.com/operations/licenses/get.json @@ -21,12 +21,12 @@ }, { "name": "license", + "description": "license parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "license parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/markdown/render.json b/openapi/api.github.com/operations/markdown/render.json index 662751ad56..5336e34aa8 100644 --- a/openapi/api.github.com/operations/markdown/render.json +++ b/openapi/api.github.com/operations/markdown/render.json @@ -48,12 +48,12 @@ "type": "object", "properties": { "text": { - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "type": "string" + "type": "string", + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less." }, "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", + "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.", "enum": [ "markdown", "gfm" @@ -61,8 +61,8 @@ "default": "markdown" }, "context": { - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", - "type": "string" + "type": "string", + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode." } }, "required": [ diff --git a/openapi/api.github.com/operations/migrations/cancel-import.json b/openapi/api.github.com/operations/migrations/cancel-import.json index 07649c3df9..c38be50cd8 100644 --- a/openapi/api.github.com/operations/migrations/cancel-import.json +++ b/openapi/api.github.com/operations/migrations/cancel-import.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/delete-archive-for-authenticated-user.json b/openapi/api.github.com/operations/migrations/delete-archive-for-authenticated-user.json index 788b2527b2..51e97974e9 100644 --- a/openapi/api.github.com/operations/migrations/delete-archive-for-authenticated-user.json +++ b/openapi/api.github.com/operations/migrations/delete-archive-for-authenticated-user.json @@ -22,12 +22,12 @@ }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/delete-archive-for-org.json b/openapi/api.github.com/operations/migrations/delete-archive-for-org.json index 08fb6c3980..1cc39c523a 100644 --- a/openapi/api.github.com/operations/migrations/delete-archive-for-org.json +++ b/openapi/api.github.com/operations/migrations/delete-archive-for-org.json @@ -22,21 +22,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-archive-for-authenticated-user.json b/openapi/api.github.com/operations/migrations/get-archive-for-authenticated-user.json index 4c3834480f..78a325ab40 100644 --- a/openapi/api.github.com/operations/migrations/get-archive-for-authenticated-user.json +++ b/openapi/api.github.com/operations/migrations/get-archive-for-authenticated-user.json @@ -22,12 +22,12 @@ }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-archive-for-org.json b/openapi/api.github.com/operations/migrations/get-archive-for-org.json index 0276b2a74f..0e54a5d636 100644 --- a/openapi/api.github.com/operations/migrations/get-archive-for-org.json +++ b/openapi/api.github.com/operations/migrations/get-archive-for-org.json @@ -22,21 +22,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-commit-authors.json b/openapi/api.github.com/operations/migrations/get-commit-authors.json index f177bbc1de..190ab840b5 100644 --- a/openapi/api.github.com/operations/migrations/get-commit-authors.json +++ b/openapi/api.github.com/operations/migrations/get-commit-authors.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "since", + "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-import-progress.json b/openapi/api.github.com/operations/migrations/get-import-progress.json index 11a9860919..0dba39bbdd 100644 --- a/openapi/api.github.com/operations/migrations/get-import-progress.json +++ b/openapi/api.github.com/operations/migrations/get-import-progress.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-large-files.json b/openapi/api.github.com/operations/migrations/get-large-files.json index 1e1453ac94..d5443018b6 100644 --- a/openapi/api.github.com/operations/migrations/get-large-files.json +++ b/openapi/api.github.com/operations/migrations/get-large-files.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-status-for-authenticated-user.json b/openapi/api.github.com/operations/migrations/get-status-for-authenticated-user.json index 121d7d688c..3f5c43579d 100644 --- a/openapi/api.github.com/operations/migrations/get-status-for-authenticated-user.json +++ b/openapi/api.github.com/operations/migrations/get-status-for-authenticated-user.json @@ -22,12 +22,12 @@ }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/get-status-for-org.json b/openapi/api.github.com/operations/migrations/get-status-for-org.json index 982ebc36d2..50940fe160 100644 --- a/openapi/api.github.com/operations/migrations/get-status-for-org.json +++ b/openapi/api.github.com/operations/migrations/get-status-for-org.json @@ -22,21 +22,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/list-for-authenticated-user.json b/openapi/api.github.com/operations/migrations/list-for-authenticated-user.json index e2a36ed91b..56a868ec26 100644 --- a/openapi/api.github.com/operations/migrations/list-for-authenticated-user.json +++ b/openapi/api.github.com/operations/migrations/list-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/list-for-org.json b/openapi/api.github.com/operations/migrations/list-for-org.json index f014586dc3..e53a46064c 100644 --- a/openapi/api.github.com/operations/migrations/list-for-org.json +++ b/openapi/api.github.com/operations/migrations/list-for-org.json @@ -22,32 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/map-commit-author.json b/openapi/api.github.com/operations/migrations/map-commit-author.json index 8597614491..416abe3221 100644 --- a/openapi/api.github.com/operations/migrations/map-commit-author.json +++ b/openapi/api.github.com/operations/migrations/map-commit-author.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "author_id", + "description": "author_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "author_id parameter" + } } ], "responses": { @@ -106,12 +106,12 @@ "type": "object", "properties": { "email": { - "description": "The new Git author email.", - "type": "string" + "type": "string", + "description": "The new Git author email." }, "name": { - "description": "The new Git author name.", - "type": "string" + "type": "string", + "description": "The new Git author name." } } } diff --git a/openapi/api.github.com/operations/migrations/set-lfs-preference.json b/openapi/api.github.com/operations/migrations/set-lfs-preference.json index 4800f43680..0d6bec0765 100644 --- a/openapi/api.github.com/operations/migrations/set-lfs-preference.json +++ b/openapi/api.github.com/operations/migrations/set-lfs-preference.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -115,8 +115,8 @@ "type": "object", "properties": { "use_lfs": { - "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", "type": "string", + "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", "enum": [ "opt_in", "opt_out" diff --git a/openapi/api.github.com/operations/migrations/start-for-authenticated-user.json b/openapi/api.github.com/operations/migrations/start-for-authenticated-user.json index 34d65de53f..0a1585525f 100644 --- a/openapi/api.github.com/operations/migrations/start-for-authenticated-user.json +++ b/openapi/api.github.com/operations/migrations/start-for-authenticated-user.json @@ -452,20 +452,20 @@ "type": "object", "properties": { "repositories": { - "description": "An array of repositories to include in the migration.", "type": "array", + "description": "An array of repositories to include in the migration.", "items": { "type": "string" } }, "lock_repositories": { - "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", "type": "boolean", + "description": "Locks the `repositories` to prevent changes during the migration when set to `true`.", "default": false }, "exclude_attachments": { - "description": "Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size.", "type": "boolean", + "description": "Does not include attachments uploaded to GitHub.com in the migration data when set to `true`. Excluding attachments will reduce the migration archive file size.", "default": false } }, diff --git a/openapi/api.github.com/operations/migrations/start-for-org.json b/openapi/api.github.com/operations/migrations/start-for-org.json index c4ecca7a29..81e9c00403 100644 --- a/openapi/api.github.com/operations/migrations/start-for-org.json +++ b/openapi/api.github.com/operations/migrations/start-for-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -443,20 +443,20 @@ "type": "object", "properties": { "repositories": { - "description": "A list of arrays indicating which repositories should be migrated.", "type": "array", + "description": "A list of arrays indicating which repositories should be migrated.", "items": { "type": "string" } }, "lock_repositories": { - "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", "type": "boolean", + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", "default": false }, "exclude_attachments": { - "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", "type": "boolean", + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", "default": false } }, diff --git a/openapi/api.github.com/operations/migrations/start-import.json b/openapi/api.github.com/operations/migrations/start-import.json index a94a361159..42fc976061 100644 --- a/openapi/api.github.com/operations/migrations/start-import.json +++ b/openapi/api.github.com/operations/migrations/start-import.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -121,12 +121,12 @@ "type": "object", "properties": { "vcs_url": { - "description": "The URL of the originating repository.", - "type": "string" + "type": "string", + "description": "The URL of the originating repository." }, "vcs": { - "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", "type": "string", + "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", "enum": [ "subversion", "git", @@ -135,16 +135,16 @@ ] }, "vcs_username": { - "description": "If authentication is required, the username to provide to `vcs_url`.", - "type": "string" + "type": "string", + "description": "If authentication is required, the username to provide to `vcs_url`." }, "vcs_password": { - "description": "If authentication is required, the password to provide to `vcs_url`.", - "type": "string" + "type": "string", + "description": "If authentication is required, the password to provide to `vcs_url`." }, "tfvc_project": { - "description": "For a tfvc import, the name of the project that is being imported.", - "type": "string" + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported." } }, "required": [ diff --git a/openapi/api.github.com/operations/migrations/unlock-repo-for-authenticated-user.json b/openapi/api.github.com/operations/migrations/unlock-repo-for-authenticated-user.json index 19834ef41a..324301f910 100644 --- a/openapi/api.github.com/operations/migrations/unlock-repo-for-authenticated-user.json +++ b/openapi/api.github.com/operations/migrations/unlock-repo-for-authenticated-user.json @@ -22,21 +22,21 @@ }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } }, { "name": "repo_name", + "description": "repo_name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo_name parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/unlock-repo-for-org.json b/openapi/api.github.com/operations/migrations/unlock-repo-for-org.json index 2ed8eae1ca..f3693e2d81 100644 --- a/openapi/api.github.com/operations/migrations/unlock-repo-for-org.json +++ b/openapi/api.github.com/operations/migrations/unlock-repo-for-org.json @@ -22,30 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "migration_id", + "description": "migration_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "migration_id parameter" + } }, { "name": "repo_name", + "description": "repo_name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo_name parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/migrations/update-import.json b/openapi/api.github.com/operations/migrations/update-import.json index 23b53d8178..6f713662b0 100644 --- a/openapi/api.github.com/operations/migrations/update-import.json +++ b/openapi/api.github.com/operations/migrations/update-import.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -100,12 +100,12 @@ "type": "object", "properties": { "vcs_username": { - "description": "The username to provide to the originating repository.", - "type": "string" + "type": "string", + "description": "The username to provide to the originating repository." }, "vcs_password": { - "description": "The password to provide to the originating repository.", - "type": "string" + "type": "string", + "description": "The password to provide to the originating repository." } } } diff --git a/openapi/api.github.com/operations/oauth-authorizations/check-authorization.json b/openapi/api.github.com/operations/oauth-authorizations/check-authorization.json index 62dbbdaa87..cff3ba8f8b 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/check-authorization.json +++ b/openapi/api.github.com/operations/oauth-authorizations/check-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/create-authorization.json b/openapi/api.github.com/operations/oauth-authorizations/create-authorization.json index ea6a173590..008aab7572 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/create-authorization.json +++ b/openapi/api.github.com/operations/oauth-authorizations/create-authorization.json @@ -107,31 +107,31 @@ "type": "object", "properties": { "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "client_id": { - "description": "The 20 character OAuth app client key for which to create the token.", - "type": "string" + "type": "string", + "description": "The 20 character OAuth app client key for which to create the token." }, "client_secret": { - "description": "The 40 character OAuth app client secret for which to create the token.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret for which to create the token." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } }, "required": [ diff --git a/openapi/api.github.com/operations/oauth-authorizations/delete-authorization.json b/openapi/api.github.com/operations/oauth-authorizations/delete-authorization.json index 10b54ef4f8..edb9088ece 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/delete-authorization.json +++ b/openapi/api.github.com/operations/oauth-authorizations/delete-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/delete-grant.json b/openapi/api.github.com/operations/oauth-authorizations/delete-grant.json index 6d5a599631..dbc182e48e 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/delete-grant.json +++ b/openapi/api.github.com/operations/oauth-authorizations/delete-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/get-authorization.json b/openapi/api.github.com/operations/oauth-authorizations/get-authorization.json index 11cbbe8c9c..c6dd3029da 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/get-authorization.json +++ b/openapi/api.github.com/operations/oauth-authorizations/get-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/get-grant.json b/openapi/api.github.com/operations/oauth-authorizations/get-grant.json index 4e0e270021..bd61407339 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/get-grant.json +++ b/openapi/api.github.com/operations/oauth-authorizations/get-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json b/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json index eb645005f8..2ee203b32b 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json +++ b/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "fingerprint", + "description": "fingerprint parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "fingerprint parameter" + } } ], "responses": { @@ -80,23 +80,23 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." } }, "required": [ diff --git a/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app.json b/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app.json index d9fe7a55d9..9b9fba855e 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app.json +++ b/openapi/api.github.com/operations/oauth-authorizations/get-or-create-authorization-for-app.json @@ -21,12 +21,12 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } } ], "responses": { @@ -57,27 +57,27 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint)." } }, "required": [ diff --git a/openapi/api.github.com/operations/oauth-authorizations/list-authorizations.json b/openapi/api.github.com/operations/oauth-authorizations/list-authorizations.json index 79d24bdcec..9a91dfa01d 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/list-authorizations.json +++ b/openapi/api.github.com/operations/oauth-authorizations/list-authorizations.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/list-grants.json b/openapi/api.github.com/operations/oauth-authorizations/list-grants.json index c8646228e4..5163d9b3c8 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/list-grants.json +++ b/openapi/api.github.com/operations/oauth-authorizations/list-grants.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/reset-authorization.json b/openapi/api.github.com/operations/oauth-authorizations/reset-authorization.json index 38be362843..1a03154adc 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/reset-authorization.json +++ b/openapi/api.github.com/operations/oauth-authorizations/reset-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/revoke-authorization-for-application.json b/openapi/api.github.com/operations/oauth-authorizations/revoke-authorization-for-application.json index 0d5ab209ef..466377ae6a 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/revoke-authorization-for-application.json +++ b/openapi/api.github.com/operations/oauth-authorizations/revoke-authorization-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/revoke-grant-for-application.json b/openapi/api.github.com/operations/oauth-authorizations/revoke-grant-for-application.json index 2f2387518f..d25415fffc 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/revoke-grant-for-application.json +++ b/openapi/api.github.com/operations/oauth-authorizations/revoke-grant-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/oauth-authorizations/update-authorization.json b/openapi/api.github.com/operations/oauth-authorizations/update-authorization.json index b8dcd6d0c6..f741d2137e 100644 --- a/openapi/api.github.com/operations/oauth-authorizations/update-authorization.json +++ b/openapi/api.github.com/operations/oauth-authorizations/update-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { @@ -116,37 +116,37 @@ "type": "object", "properties": { "scopes": { - "description": "Replaces the authorization scopes with these.", "type": "array", + "description": "Replaces the authorization scopes with these.", "items": { "type": "string" } }, "add_scopes": { - "description": "A list of scopes to add to this authorization.", "type": "array", + "description": "A list of scopes to add to this authorization.", "items": { "type": "string" } }, "remove_scopes": { - "description": "A list of scopes to remove from this authorization.", "type": "array", + "description": "A list of scopes to remove from this authorization.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } } } diff --git a/openapi/api.github.com/operations/orgs/add-or-update-membership.json b/openapi/api.github.com/operations/orgs/add-or-update-membership.json index 1652171244..3643425d54 100644 --- a/openapi/api.github.com/operations/orgs/add-or-update-membership.json +++ b/openapi/api.github.com/operations/orgs/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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", + "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.", "enum": [ "admin", "member" diff --git a/openapi/api.github.com/operations/orgs/block-user.json b/openapi/api.github.com/operations/orgs/block-user.json index 934d80e366..5d3465b971 100644 --- a/openapi/api.github.com/operations/orgs/block-user.json +++ b/openapi/api.github.com/operations/orgs/block-user.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/check-blocked-user.json b/openapi/api.github.com/operations/orgs/check-blocked-user.json index 4754639ee9..9b8828afbb 100644 --- a/openapi/api.github.com/operations/orgs/check-blocked-user.json +++ b/openapi/api.github.com/operations/orgs/check-blocked-user.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/check-membership.json b/openapi/api.github.com/operations/orgs/check-membership.json index 47b327f894..f8d828e364 100644 --- a/openapi/api.github.com/operations/orgs/check-membership.json +++ b/openapi/api.github.com/operations/orgs/check-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/check-public-membership.json b/openapi/api.github.com/operations/orgs/check-public-membership.json index 95f3cf761a..19db0f5d9f 100644 --- a/openapi/api.github.com/operations/orgs/check-public-membership.json +++ b/openapi/api.github.com/operations/orgs/check-public-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/conceal-membership.json b/openapi/api.github.com/operations/orgs/conceal-membership.json index d293e1ae33..d2cda890c3 100644 --- a/openapi/api.github.com/operations/orgs/conceal-membership.json +++ b/openapi/api.github.com/operations/orgs/conceal-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/convert-member-to-outside-collaborator.json b/openapi/api.github.com/operations/orgs/convert-member-to-outside-collaborator.json index da8d53afc3..f802c94920 100644 --- a/openapi/api.github.com/operations/orgs/convert-member-to-outside-collaborator.json +++ b/openapi/api.github.com/operations/orgs/convert-member-to-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/create-hook.json b/openapi/api.github.com/operations/orgs/create-hook.json index 9bdc32b293..6b18e528fa 100644 --- a/openapi/api.github.com/operations/orgs/create-hook.json +++ b/openapi/api.github.com/operations/orgs/create-hook.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -104,28 +104,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "secret": { - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -133,8 +133,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -143,8 +143,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/api.github.com/operations/orgs/create-invitation.json b/openapi/api.github.com/operations/orgs/create-invitation.json index a58af9f45e..acb0ac292a 100644 --- a/openapi/api.github.com/operations/orgs/create-invitation.json +++ b/openapi/api.github.com/operations/orgs/create-invitation.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -147,16 +147,16 @@ "type": "object", "properties": { "invitee_id": { - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", - "type": "integer" + "type": "integer", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." }, "email": { - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", - "type": "string" + "type": "string", + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." }, "role": { - "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", "type": "string", + "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", "enum": [ "admin", "direct_member", @@ -165,8 +165,8 @@ "default": "direct_member" }, "team_ids": { - "description": "Specify IDs for the teams you want to invite new members to.", "type": "array", + "description": "Specify IDs for the teams you want to invite new members to.", "items": { "type": "integer" } diff --git a/openapi/api.github.com/operations/orgs/delete-hook.json b/openapi/api.github.com/operations/orgs/delete-hook.json index e5dda9d3c3..cb48aa7615 100644 --- a/openapi/api.github.com/operations/orgs/delete-hook.json +++ b/openapi/api.github.com/operations/orgs/delete-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/get-hook.json b/openapi/api.github.com/operations/orgs/get-hook.json index 3a796b1106..87299757cd 100644 --- a/openapi/api.github.com/operations/orgs/get-hook.json +++ b/openapi/api.github.com/operations/orgs/get-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/get-membership-for-authenticated-user.json b/openapi/api.github.com/operations/orgs/get-membership-for-authenticated-user.json index 4cc27378b8..52edb7c815 100644 --- a/openapi/api.github.com/operations/orgs/get-membership-for-authenticated-user.json +++ b/openapi/api.github.com/operations/orgs/get-membership-for-authenticated-user.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/get-membership.json b/openapi/api.github.com/operations/orgs/get-membership.json index abf5570767..55afa1df1e 100644 --- a/openapi/api.github.com/operations/orgs/get-membership.json +++ b/openapi/api.github.com/operations/orgs/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/get.json b/openapi/api.github.com/operations/orgs/get.json index 4b79d8bbb9..01a2ac4d95 100644 --- a/openapi/api.github.com/operations/orgs/get.json +++ b/openapi/api.github.com/operations/orgs/get.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-blocked-users.json b/openapi/api.github.com/operations/orgs/list-blocked-users.json index b87ec13de0..296ecd49c2 100644 --- a/openapi/api.github.com/operations/orgs/list-blocked-users.json +++ b/openapi/api.github.com/operations/orgs/list-blocked-users.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-credential-authorizations.json b/openapi/api.github.com/operations/orgs/list-credential-authorizations.json index a8a645da27..3176474298 100644 --- a/openapi/api.github.com/operations/orgs/list-credential-authorizations.json +++ b/openapi/api.github.com/operations/orgs/list-credential-authorizations.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-for-authenticated-user.json b/openapi/api.github.com/operations/orgs/list-for-authenticated-user.json index d94428572f..f8579d0117 100644 --- a/openapi/api.github.com/operations/orgs/list-for-authenticated-user.json +++ b/openapi/api.github.com/operations/orgs/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-for-user.json b/openapi/api.github.com/operations/orgs/list-for-user.json index b10e644b51..12d58fc6a6 100644 --- a/openapi/api.github.com/operations/orgs/list-for-user.json +++ b/openapi/api.github.com/operations/orgs/list-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-hooks.json b/openapi/api.github.com/operations/orgs/list-hooks.json index e07b5d50a8..52c453af7e 100644 --- a/openapi/api.github.com/operations/orgs/list-hooks.json +++ b/openapi/api.github.com/operations/orgs/list-hooks.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-invitation-teams.json b/openapi/api.github.com/operations/orgs/list-invitation-teams.json index 723498aa4d..223db881f4 100644 --- a/openapi/api.github.com/operations/orgs/list-invitation-teams.json +++ b/openapi/api.github.com/operations/orgs/list-invitation-teams.json @@ -21,41 +21,39 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-members.json b/openapi/api.github.com/operations/orgs/list-members.json index bc959e8604..3730be0a11 100644 --- a/openapi/api.github.com/operations/orgs/list-members.json +++ b/openapi/api.github.com/operations/orgs/list-members.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "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", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-memberships.json b/openapi/api.github.com/operations/orgs/list-memberships.json index 3a284ea836..fb46c51ebd 100644 --- a/openapi/api.github.com/operations/orgs/list-memberships.json +++ b/openapi/api.github.com/operations/orgs/list-memberships.json @@ -21,36 +21,34 @@ }, { "name": "state", + "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.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-outside-collaborators.json b/openapi/api.github.com/operations/orgs/list-outside-collaborators.json index f02340bacb..82ea9d590c 100644 --- a/openapi/api.github.com/operations/orgs/list-outside-collaborators.json +++ b/openapi/api.github.com/operations/orgs/list-outside-collaborators.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,29 +40,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-pending-invitations.json b/openapi/api.github.com/operations/orgs/list-pending-invitations.json index e2fd7341fa..b1bdbc70f8 100644 --- a/openapi/api.github.com/operations/orgs/list-pending-invitations.json +++ b/openapi/api.github.com/operations/orgs/list-pending-invitations.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list-public-members.json b/openapi/api.github.com/operations/orgs/list-public-members.json index e7a2ea92af..7f95a8387e 100644 --- a/openapi/api.github.com/operations/orgs/list-public-members.json +++ b/openapi/api.github.com/operations/orgs/list-public-members.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/list.json b/openapi/api.github.com/operations/orgs/list.json index e4cc10e110..441e24f2ce 100644 --- a/openapi/api.github.com/operations/orgs/list.json +++ b/openapi/api.github.com/operations/orgs/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last Organization that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Organization that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/ping-hook.json b/openapi/api.github.com/operations/orgs/ping-hook.json index 7c9197066d..165d533f0e 100644 --- a/openapi/api.github.com/operations/orgs/ping-hook.json +++ b/openapi/api.github.com/operations/orgs/ping-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/publicize-membership.json b/openapi/api.github.com/operations/orgs/publicize-membership.json index 38186b1cf6..1ff6714895 100644 --- a/openapi/api.github.com/operations/orgs/publicize-membership.json +++ b/openapi/api.github.com/operations/orgs/publicize-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/remove-credential-authorization.json b/openapi/api.github.com/operations/orgs/remove-credential-authorization.json index e78e36c14a..d2f478f4dd 100644 --- a/openapi/api.github.com/operations/orgs/remove-credential-authorization.json +++ b/openapi/api.github.com/operations/orgs/remove-credential-authorization.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "credential_id", + "description": "credential_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "credential_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/remove-member.json b/openapi/api.github.com/operations/orgs/remove-member.json index 27b32d75bd..f47eda3259 100644 --- a/openapi/api.github.com/operations/orgs/remove-member.json +++ b/openapi/api.github.com/operations/orgs/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/remove-membership.json b/openapi/api.github.com/operations/orgs/remove-membership.json index 2006fdc123..4849693e9e 100644 --- a/openapi/api.github.com/operations/orgs/remove-membership.json +++ b/openapi/api.github.com/operations/orgs/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/remove-outside-collaborator.json b/openapi/api.github.com/operations/orgs/remove-outside-collaborator.json index 4749e78be4..c6b4db0af3 100644 --- a/openapi/api.github.com/operations/orgs/remove-outside-collaborator.json +++ b/openapi/api.github.com/operations/orgs/remove-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/unblock-user.json b/openapi/api.github.com/operations/orgs/unblock-user.json index 957ffae861..21026053d2 100644 --- a/openapi/api.github.com/operations/orgs/unblock-user.json +++ b/openapi/api.github.com/operations/orgs/unblock-user.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/orgs/update-hook.json b/openapi/api.github.com/operations/orgs/update-hook.json index 7d3de14957..ec1843d26e 100644 --- a/openapi/api.github.com/operations/orgs/update-hook.json +++ b/openapi/api.github.com/operations/orgs/update-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -113,24 +113,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "secret": { - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -138,8 +138,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -148,8 +148,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/api.github.com/operations/orgs/update-membership.json b/openapi/api.github.com/operations/orgs/update-membership.json index 393bd7a174..1d86025c37 100644 --- a/openapi/api.github.com/operations/orgs/update-membership.json +++ b/openapi/api.github.com/operations/orgs/update-membership.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -178,8 +178,8 @@ "type": "object", "properties": { "state": { - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "type": "string", + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "enum": [ "active" ] diff --git a/openapi/api.github.com/operations/orgs/update.json b/openapi/api.github.com/operations/orgs/update.json index 2f3e8b22b6..02eb0735f5 100644 --- a/openapi/api.github.com/operations/orgs/update.json +++ b/openapi/api.github.com/operations/orgs/update.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -191,40 +191,40 @@ "type": "object", "properties": { "billing_email": { - "description": "Billing email address. This address is not publicized.", - "type": "string" + "type": "string", + "description": "Billing email address. This address is not publicized." }, "company": { - "description": "The company name.", - "type": "string" + "type": "string", + "description": "The company name." }, "email": { - "description": "The publicly visible email address.", - "type": "string" + "type": "string", + "description": "The publicly visible email address." }, "location": { - "description": "The location.", - "type": "string" + "type": "string", + "description": "The location." }, "name": { - "description": "The shorthand name of the company.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, "description": { - "description": "The description of the company.", - "type": "string" + "type": "string", + "description": "The description of the company." }, "has_organization_projects": { - "description": "Toggles whether organization projects are enabled for the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether organization projects are enabled for the organization." }, "has_repository_projects": { - "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization." }, "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", + "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.", "enum": [ "read", "write", @@ -234,13 +234,13 @@ "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. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", "type": "boolean", + "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. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", "default": true }, "members_allowed_repository_creation_type": { - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", "enum": [ "all", "private", diff --git a/openapi/api.github.com/operations/projects/add-collaborator.json b/openapi/api.github.com/operations/projects/add-collaborator.json index 8c7236fdf5..99c070fd66 100644 --- a/openapi/api.github.com/operations/projects/add-collaborator.json +++ b/openapi/api.github.com/operations/projects/add-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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/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", + "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", "enum": [ "read", "write", diff --git a/openapi/api.github.com/operations/projects/create-card.json b/openapi/api.github.com/operations/projects/create-card.json index 77a706d205..407caeb39f 100644 --- a/openapi/api.github.com/operations/projects/create-card.json +++ b/openapi/api.github.com/operations/projects/create-card.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -156,16 +156,16 @@ "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" + "type": "string", + "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`." }, "content_id": { - "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", - "type": "integer" + "type": "integer", + "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/api.github.com/operations/projects/create-column.json b/openapi/api.github.com/operations/projects/create-column.json index 3c0aef6b6e..734d597f7b 100644 --- a/openapi/api.github.com/operations/projects/create-column.json +++ b/openapi/api.github.com/operations/projects/create-column.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The name of the column.", - "type": "string" + "type": "string", + "description": "The name of the column." } }, "required": [ diff --git a/openapi/api.github.com/operations/projects/create-for-authenticated-user.json b/openapi/api.github.com/operations/projects/create-for-authenticated-user.json index b4e3f9b463..437dd137c9 100644 --- a/openapi/api.github.com/operations/projects/create-for-authenticated-user.json +++ b/openapi/api.github.com/operations/projects/create-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -173,12 +171,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/api.github.com/operations/projects/create-for-org.json b/openapi/api.github.com/operations/projects/create-for-org.json index ee497d4515..6a049b8a3a 100644 --- a/openapi/api.github.com/operations/projects/create-for-org.json +++ b/openapi/api.github.com/operations/projects/create-for-org.json @@ -22,32 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,12 +180,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/api.github.com/operations/projects/create-for-repo.json b/openapi/api.github.com/operations/projects/create-for-repo.json index 283e7b930c..8c7e43a7a2 100644 --- a/openapi/api.github.com/operations/projects/create-for-repo.json +++ b/openapi/api.github.com/operations/projects/create-for-repo.json @@ -22,41 +22,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -191,12 +189,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/api.github.com/operations/projects/delete-card.json b/openapi/api.github.com/operations/projects/delete-card.json index a7fc7e1bdd..6fa0ff0598 100644 --- a/openapi/api.github.com/operations/projects/delete-card.json +++ b/openapi/api.github.com/operations/projects/delete-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/delete-column.json b/openapi/api.github.com/operations/projects/delete-column.json index bed7718281..4da50b0821 100644 --- a/openapi/api.github.com/operations/projects/delete-column.json +++ b/openapi/api.github.com/operations/projects/delete-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/delete.json b/openapi/api.github.com/operations/projects/delete.json index 67dd20fa51..10eb917d47 100644 --- a/openapi/api.github.com/operations/projects/delete.json +++ b/openapi/api.github.com/operations/projects/delete.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/get-card.json b/openapi/api.github.com/operations/projects/get-card.json index 41521e766c..508a5201a3 100644 --- a/openapi/api.github.com/operations/projects/get-card.json +++ b/openapi/api.github.com/operations/projects/get-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/get-column.json b/openapi/api.github.com/operations/projects/get-column.json index 26456d95a5..a30b08f08a 100644 --- a/openapi/api.github.com/operations/projects/get-column.json +++ b/openapi/api.github.com/operations/projects/get-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/get.json b/openapi/api.github.com/operations/projects/get.json index 173139dd81..a6a26d822b 100644 --- a/openapi/api.github.com/operations/projects/get.json +++ b/openapi/api.github.com/operations/projects/get.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/list-cards.json b/openapi/api.github.com/operations/projects/list-cards.json index a5215ce094..bbb6b1c783 100644 --- a/openapi/api.github.com/operations/projects/list-cards.json +++ b/openapi/api.github.com/operations/projects/list-cards.json @@ -22,16 +22,18 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } }, { "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "not_archived" ], "default": "not_archived" - }, - "required": false, - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/list-collaborators.json b/openapi/api.github.com/operations/projects/list-collaborators.json index dadec01772..efc2b74e06 100644 --- a/openapi/api.github.com/operations/projects/list-collaborators.json +++ b/openapi/api.github.com/operations/projects/list-collaborators.json @@ -22,16 +22,18 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/list-columns.json b/openapi/api.github.com/operations/projects/list-columns.json index fcc6df35d9..ee6df73944 100644 --- a/openapi/api.github.com/operations/projects/list-columns.json +++ b/openapi/api.github.com/operations/projects/list-columns.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/list-for-org.json b/openapi/api.github.com/operations/projects/list-for-org.json index aee55fbdc6..a05b31e58d 100644 --- a/openapi/api.github.com/operations/projects/list-for-org.json +++ b/openapi/api.github.com/operations/projects/list-for-org.json @@ -22,16 +22,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/list-for-repo.json b/openapi/api.github.com/operations/projects/list-for-repo.json index 501b43d610..896690b1cc 100644 --- a/openapi/api.github.com/operations/projects/list-for-repo.json +++ b/openapi/api.github.com/operations/projects/list-for-repo.json @@ -22,25 +22,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -49,29 +51,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/list-for-user.json b/openapi/api.github.com/operations/projects/list-for-user.json index d2455d5813..7f50d7d775 100644 --- a/openapi/api.github.com/operations/projects/list-for-user.json +++ b/openapi/api.github.com/operations/projects/list-for-user.json @@ -22,16 +22,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/move-card.json b/openapi/api.github.com/operations/projects/move-card.json index 08b25f139d..01c0123e5a 100644 --- a/openapi/api.github.com/operations/projects/move-card.json +++ b/openapi/api.github.com/operations/projects/move-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,13 +58,13 @@ "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", + "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`.", "pattern": "^(top|bottom|after:\\d+)$" }, "column_id": { - "description": "The `id` value of a column in the same project.", - "type": "integer" + "type": "integer", + "description": "The `id` value of a column in the same project." } }, "required": [ diff --git a/openapi/api.github.com/operations/projects/move-column.json b/openapi/api.github.com/operations/projects/move-column.json index 10f809eac2..246e1c8720 100644 --- a/openapi/api.github.com/operations/projects/move-column.json +++ b/openapi/api.github.com/operations/projects/move-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "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", + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", "pattern": "^(first|last|after:\\d+)$" } }, diff --git a/openapi/api.github.com/operations/projects/remove-collaborator.json b/openapi/api.github.com/operations/projects/remove-collaborator.json index a2e9c12f55..9d51a07e35 100644 --- a/openapi/api.github.com/operations/projects/remove-collaborator.json +++ b/openapi/api.github.com/operations/projects/remove-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/review-user-permission-level.json b/openapi/api.github.com/operations/projects/review-user-permission-level.json index f1fbcbfc2a..2b5a4ccd2e 100644 --- a/openapi/api.github.com/operations/projects/review-user-permission-level.json +++ b/openapi/api.github.com/operations/projects/review-user-permission-level.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/projects/update-card.json b/openapi/api.github.com/operations/projects/update-card.json index 3a387bc750..62d20c9b86 100644 --- a/openapi/api.github.com/operations/projects/update-card.json +++ b/openapi/api.github.com/operations/projects/update-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,12 +58,12 @@ "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" + "type": "string", + "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`." }, "archived": { - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "type": "boolean" + "type": "boolean", + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card." } } } diff --git a/openapi/api.github.com/operations/projects/update-column.json b/openapi/api.github.com/operations/projects/update-column.json index 208d16de75..b48360e74d 100644 --- a/openapi/api.github.com/operations/projects/update-column.json +++ b/openapi/api.github.com/operations/projects/update-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The new name of the column.", - "type": "string" + "type": "string", + "description": "The new name of the column." } }, "required": [ diff --git a/openapi/api.github.com/operations/projects/update.json b/openapi/api.github.com/operations/projects/update.json index 83dcdcca0b..d887155521 100644 --- a/openapi/api.github.com/operations/projects/update.json +++ b/openapi/api.github.com/operations/projects/update.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,28 +180,28 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." }, "state": { - "description": "State of the project. Either `open` or `closed`.", "type": "string", + "description": "State of the project. Either `open` or `closed`.", "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/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", - "type": "string" + "type": "string", + "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public." }, "private": { - "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", - "type": "boolean" + "type": "boolean", + "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account." } } } diff --git a/openapi/api.github.com/operations/pulls/check-if-merged.json b/openapi/api.github.com/operations/pulls/check-if-merged.json index 3cf041c1ee..90becbb7d6 100644 --- a/openapi/api.github.com/operations/pulls/check-if-merged.json +++ b/openapi/api.github.com/operations/pulls/check-if-merged.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/create-comment-reply.json b/openapi/api.github.com/operations/pulls/create-comment-reply.json index 0566eeda10..6644ae31ed 100644 --- a/openapi/api.github.com/operations/pulls/create-comment-reply.json +++ b/openapi/api.github.com/operations/pulls/create-comment-reply.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,12 +231,12 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/create-comment.json b/openapi/api.github.com/operations/pulls/create-comment.json index 1c0582a1b3..39e2144faa 100644 --- a/openapi/api.github.com/operations/pulls/create-comment.json +++ b/openapi/api.github.com/operations/pulls/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,20 +231,20 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "string", + "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`." }, "path": { - "description": "The relative path to the file that necessitates a comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/create-from-issue.json b/openapi/api.github.com/operations/pulls/create-from-issue.json index 7196f48c12..cf77886afc 100644 --- a/openapi/api.github.com/operations/pulls/create-from-issue.json +++ b/openapi/api.github.com/operations/pulls/create-from-issue.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1517,24 +1517,24 @@ "type": "object", "properties": { "issue": { - "description": "The issue number in this repository to turn into a Pull Request.", - "type": "integer" + "type": "integer", + "description": "The issue number in this repository to turn into a Pull Request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." }, "draft": { - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "type": "boolean" + "type": "boolean", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/create-review-request.json b/openapi/api.github.com/operations/pulls/create-review-request.json index 9473110b64..4dc0be3f0a 100644 --- a/openapi/api.github.com/operations/pulls/create-review-request.json +++ b/openapi/api.github.com/operations/pulls/create-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1464,15 +1464,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be requested.", "type": "array", + "description": "An array of user `login`s that will be requested.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be requested.", "type": "array", + "description": "An array of team `slug`s that will be requested.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/pulls/create-review.json b/openapi/api.github.com/operations/pulls/create-review.json index 838c6b062b..5e36bc2284 100644 --- a/openapi/api.github.com/operations/pulls/create-review.json +++ b/openapi/api.github.com/operations/pulls/create-review.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -196,16 +196,16 @@ "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" + "type": "string", + "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." }, "body": { - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "type": "string" + "type": "string", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." }, "event": { - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "type": "string", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -213,22 +213,22 @@ ] }, "comments": { - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "type": "array", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "items": { "type": "object", "properties": { "path": { - "description": "The relative path to the file that necessitates a review comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a review comment." }, "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" + "type": "integer", + "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." }, "body": { - "description": "Text of the review comment.", - "type": "string" + "type": "string", + "description": "Text of the review comment." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/create.json b/openapi/api.github.com/operations/pulls/create.json index 621e54be6e..92448330c3 100644 --- a/openapi/api.github.com/operations/pulls/create.json +++ b/openapi/api.github.com/operations/pulls/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1517,28 +1517,28 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "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" + "type": "boolean", + "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." }, "draft": { - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "type": "boolean" + "type": "boolean", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/delete-comment.json b/openapi/api.github.com/operations/pulls/delete-comment.json index 06954a8ed1..e8cce70631 100644 --- a/openapi/api.github.com/operations/pulls/delete-comment.json +++ b/openapi/api.github.com/operations/pulls/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/delete-pending-review.json b/openapi/api.github.com/operations/pulls/delete-pending-review.json index b756d915cb..fba41024f9 100644 --- a/openapi/api.github.com/operations/pulls/delete-pending-review.json +++ b/openapi/api.github.com/operations/pulls/delete-pending-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/delete-review-request.json b/openapi/api.github.com/operations/pulls/delete-review-request.json index c9f8b35a89..5851b25e07 100644 --- a/openapi/api.github.com/operations/pulls/delete-review-request.json +++ b/openapi/api.github.com/operations/pulls/delete-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -85,15 +85,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be removed.", "type": "array", + "description": "An array of user `login`s that will be removed.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be removed.", "type": "array", + "description": "An array of team `slug`s that will be removed.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/pulls/dismiss-review.json b/openapi/api.github.com/operations/pulls/dismiss-review.json index d581009b1d..b10cf5d5d8 100644 --- a/openapi/api.github.com/operations/pulls/dismiss-review.json +++ b/openapi/api.github.com/operations/pulls/dismiss-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,8 +204,8 @@ "type": "object", "properties": { "message": { - "description": "The message for the pull request review dismissal", - "type": "string" + "type": "string", + "description": "The message for the pull request review dismissal" } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/get-comment.json b/openapi/api.github.com/operations/pulls/get-comment.json index 44f59ba653..4e0932f260 100644 --- a/openapi/api.github.com/operations/pulls/get-comment.json +++ b/openapi/api.github.com/operations/pulls/get-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/get-comments-for-review.json b/openapi/api.github.com/operations/pulls/get-comments-for-review.json index d522a5197e..87dae51d49 100644 --- a/openapi/api.github.com/operations/pulls/get-comments-for-review.json +++ b/openapi/api.github.com/operations/pulls/get-comments-for-review.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/get-review.json b/openapi/api.github.com/operations/pulls/get-review.json index 9b11896fcd..c528ca311a 100644 --- a/openapi/api.github.com/operations/pulls/get-review.json +++ b/openapi/api.github.com/operations/pulls/get-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/get.json b/openapi/api.github.com/operations/pulls/get.json index f1e10585e0..a714062280 100644 --- a/openapi/api.github.com/operations/pulls/get.json +++ b/openapi/api.github.com/operations/pulls/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list-comments-for-repo.json b/openapi/api.github.com/operations/pulls/list-comments-for-repo.json index 6e4746cb0b..05c733a6dc 100644 --- a/openapi/api.github.com/operations/pulls/list-comments-for-repo.json +++ b/openapi/api.github.com/operations/pulls/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,51 +49,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list-comments.json b/openapi/api.github.com/operations/pulls/list-comments.json index 02ba7cbe67..22324c0df9 100644 --- a/openapi/api.github.com/operations/pulls/list-comments.json +++ b/openapi/api.github.com/operations/pulls/list-comments.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,51 +58,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list-commits.json b/openapi/api.github.com/operations/pulls/list-commits.json index 7aa9de394d..2c82e22e52 100644 --- a/openapi/api.github.com/operations/pulls/list-commits.json +++ b/openapi/api.github.com/operations/pulls/list-commits.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list-files.json b/openapi/api.github.com/operations/pulls/list-files.json index 2531856da2..fded969418 100644 --- a/openapi/api.github.com/operations/pulls/list-files.json +++ b/openapi/api.github.com/operations/pulls/list-files.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list-review-requests.json b/openapi/api.github.com/operations/pulls/list-review-requests.json index 4643033275..bbfe7155de 100644 --- a/openapi/api.github.com/operations/pulls/list-review-requests.json +++ b/openapi/api.github.com/operations/pulls/list-review-requests.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list-reviews.json b/openapi/api.github.com/operations/pulls/list-reviews.json index ae54a2617e..daa5f9beec 100644 --- a/openapi/api.github.com/operations/pulls/list-reviews.json +++ b/openapi/api.github.com/operations/pulls/list-reviews.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/list.json b/openapi/api.github.com/operations/pulls/list.json index 53d6cb955d..ca295b3551 100644 --- a/openapi/api.github.com/operations/pulls/list.json +++ b/openapi/api.github.com/operations/pulls/list.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,31 +50,31 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Either `open`, `closed`, or `all` to filter by state." + } }, { "name": "head", + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", "in": "query", + "required": false, "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", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter pulls by base branch name. Example: `gh-pages`." + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -82,42 +84,38 @@ "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", + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/pulls/merge.json b/openapi/api.github.com/operations/pulls/merge.json index f2b91deb7d..333c1e0073 100644 --- a/openapi/api.github.com/operations/pulls/merge.json +++ b/openapi/api.github.com/operations/pulls/merge.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -86,20 +86,20 @@ "type": "object", "properties": { "commit_title": { - "description": "Title for the automatic commit message.", - "type": "string" + "type": "string", + "description": "Title for the automatic commit message." }, "commit_message": { - "description": "Extra detail to append to automatic commit message.", - "type": "string" + "type": "string", + "description": "Extra detail to append to automatic commit message." }, "sha": { - "description": "SHA that pull request head must match to allow merge.", - "type": "string" + "type": "string", + "description": "SHA that pull request head must match to allow merge." }, "merge_method": { - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "type": "string", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "enum": [ "merge", "squash", diff --git a/openapi/api.github.com/operations/pulls/submit-review.json b/openapi/api.github.com/operations/pulls/submit-review.json index 34d4a68691..d2f36a824c 100644 --- a/openapi/api.github.com/operations/pulls/submit-review.json +++ b/openapi/api.github.com/operations/pulls/submit-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,12 +204,12 @@ "type": "object", "properties": { "body": { - "description": "The body text of the pull request review", - "type": "string" + "type": "string", + "description": "The body text of the pull request review" }, "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", + "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.", "enum": [ "APPROVE", "REQUEST_CHANGES", diff --git a/openapi/api.github.com/operations/pulls/update-branch.json b/openapi/api.github.com/operations/pulls/update-branch.json index 4be5c264de..b0d05d5f6f 100644 --- a/openapi/api.github.com/operations/pulls/update-branch.json +++ b/openapi/api.github.com/operations/pulls/update-branch.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -91,8 +91,8 @@ "type": "object", "properties": { "expected_head_sha": { - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "type": "string" + "type": "string", + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." } } } diff --git a/openapi/api.github.com/operations/pulls/update-comment.json b/openapi/api.github.com/operations/pulls/update-comment.json index 88d03054dc..81322ddbb1 100644 --- a/openapi/api.github.com/operations/pulls/update-comment.json +++ b/openapi/api.github.com/operations/pulls/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -220,8 +220,8 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/update-review.json b/openapi/api.github.com/operations/pulls/update-review.json index 4af10561a2..7ef56910e7 100644 --- a/openapi/api.github.com/operations/pulls/update-review.json +++ b/openapi/api.github.com/operations/pulls/update-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,8 +204,8 @@ "type": "object", "properties": { "body": { - "description": "The body text of the pull request review.", - "type": "string" + "type": "string", + "description": "The body text of the pull request review." } }, "required": [ diff --git a/openapi/api.github.com/operations/pulls/update.json b/openapi/api.github.com/operations/pulls/update.json index e563ab115c..d825e4c5a3 100644 --- a/openapi/api.github.com/operations/pulls/update.json +++ b/openapi/api.github.com/operations/pulls/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1535,28 +1535,28 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", + "description": "State of this Pull Request. Either `open` or `closed`.", "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." } } } diff --git a/openapi/api.github.com/operations/reactions/create-for-commit-comment.json b/openapi/api.github.com/operations/reactions/create-for-commit-comment.json index 5f3cd2959c..bc808326fe 100644 --- a/openapi/api.github.com/operations/reactions/create-for-commit-comment.json +++ b/openapi/api.github.com/operations/reactions/create-for-commit-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", "enum": [ "+1", "-1", diff --git a/openapi/api.github.com/operations/reactions/create-for-issue-comment.json b/openapi/api.github.com/operations/reactions/create-for-issue-comment.json index 42d8c381b6..69c71d1ebc 100644 --- a/openapi/api.github.com/operations/reactions/create-for-issue-comment.json +++ b/openapi/api.github.com/operations/reactions/create-for-issue-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", "enum": [ "+1", "-1", diff --git a/openapi/api.github.com/operations/reactions/create-for-issue.json b/openapi/api.github.com/operations/reactions/create-for-issue.json index 2a42cb1815..65dd372f43 100644 --- a/openapi/api.github.com/operations/reactions/create-for-issue.json +++ b/openapi/api.github.com/operations/reactions/create-for-issue.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -166,8 +166,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", "type": "string", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", "enum": [ "+1", "-1", diff --git a/openapi/api.github.com/operations/reactions/create-for-pull-request-review-comment.json b/openapi/api.github.com/operations/reactions/create-for-pull-request-review-comment.json index b48c86be1b..74266058e9 100644 --- a/openapi/api.github.com/operations/reactions/create-for-pull-request-review-comment.json +++ b/openapi/api.github.com/operations/reactions/create-for-pull-request-review-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", "enum": [ "+1", "-1", diff --git a/openapi/api.github.com/operations/reactions/create-for-team-discussion-comment.json b/openapi/api.github.com/operations/reactions/create-for-team-discussion-comment.json index ce29236271..0aec462cd8 100644 --- a/openapi/api.github.com/operations/reactions/create-for-team-discussion-comment.json +++ b/openapi/api.github.com/operations/reactions/create-for-team-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", "enum": [ "+1", "-1", diff --git a/openapi/api.github.com/operations/reactions/create-for-team-discussion.json b/openapi/api.github.com/operations/reactions/create-for-team-discussion.json index 5295bc45d8..4da864eb9d 100644 --- a/openapi/api.github.com/operations/reactions/create-for-team-discussion.json +++ b/openapi/api.github.com/operations/reactions/create-for-team-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -147,8 +147,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", "type": "string", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", "enum": [ "+1", "-1", diff --git a/openapi/api.github.com/operations/reactions/delete.json b/openapi/api.github.com/operations/reactions/delete.json index 545c7da5c3..b944d73272 100644 --- a/openapi/api.github.com/operations/reactions/delete.json +++ b/openapi/api.github.com/operations/reactions/delete.json @@ -22,12 +22,12 @@ }, { "name": "reaction_id", + "description": "reaction_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "reaction_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/reactions/list-for-commit-comment.json b/openapi/api.github.com/operations/reactions/list-for-commit-comment.json index ada4b0104a..268a43295a 100644 --- a/openapi/api.github.com/operations/reactions/list-for-commit-comment.json +++ b/openapi/api.github.com/operations/reactions/list-for-commit-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/reactions/list-for-issue-comment.json b/openapi/api.github.com/operations/reactions/list-for-issue-comment.json index fde50fb669..6a185b8a03 100644 --- a/openapi/api.github.com/operations/reactions/list-for-issue-comment.json +++ b/openapi/api.github.com/operations/reactions/list-for-issue-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/reactions/list-for-issue.json b/openapi/api.github.com/operations/reactions/list-for-issue.json index 309770f9ff..f77f6e65da 100644 --- a/openapi/api.github.com/operations/reactions/list-for-issue.json +++ b/openapi/api.github.com/operations/reactions/list-for-issue.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/reactions/list-for-pull-request-review-comment.json b/openapi/api.github.com/operations/reactions/list-for-pull-request-review-comment.json index 741c11073e..bada35b2d5 100644 --- a/openapi/api.github.com/operations/reactions/list-for-pull-request-review-comment.json +++ b/openapi/api.github.com/operations/reactions/list-for-pull-request-review-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/reactions/list-for-team-discussion-comment.json b/openapi/api.github.com/operations/reactions/list-for-team-discussion-comment.json index 6fbf5ca80b..a39a78e688 100644 --- a/openapi/api.github.com/operations/reactions/list-for-team-discussion-comment.json +++ b/openapi/api.github.com/operations/reactions/list-for-team-discussion-comment.json @@ -22,34 +22,36 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/reactions/list-for-team-discussion.json b/openapi/api.github.com/operations/reactions/list-for-team-discussion.json index d40f9958b1..4135117806 100644 --- a/openapi/api.github.com/operations/reactions/list-for-team-discussion.json +++ b/openapi/api.github.com/operations/reactions/list-for-team-discussion.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/accept-invitation.json b/openapi/api.github.com/operations/repos/accept-invitation.json index 4f68dedc7c..bbfdb2f4b2 100644 --- a/openapi/api.github.com/operations/repos/accept-invitation.json +++ b/openapi/api.github.com/operations/repos/accept-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/add-collaborator.json b/openapi/api.github.com/operations/repos/add-collaborator.json index baef56fd30..b5d3717cc7 100644 --- a/openapi/api.github.com/operations/repos/add-collaborator.json +++ b/openapi/api.github.com/operations/repos/add-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -76,8 +76,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/api.github.com/operations/repos/add-deploy-key.json b/openapi/api.github.com/operations/repos/add-deploy-key.json index dc0044bf96..2ff87fec15 100644 --- a/openapi/api.github.com/operations/repos/add-deploy-key.json +++ b/openapi/api.github.com/operations/repos/add-deploy-key.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "type": "object", "properties": { "title": { - "description": "A name for the key.", - "type": "string" + "type": "string", + "description": "A name for the key." }, "key": { - "description": "The contents of the key.", - "type": "string" + "type": "string", + "description": "The contents of the key." }, "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" + "type": "boolean", + "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/).\"" } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/add-protected-branch-admin-enforcement.json b/openapi/api.github.com/operations/repos/add-protected-branch-admin-enforcement.json index ca03dd559d..2ab198da45 100644 --- a/openapi/api.github.com/operations/repos/add-protected-branch-admin-enforcement.json +++ b/openapi/api.github.com/operations/repos/add-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/add-protected-branch-required-signatures.json b/openapi/api.github.com/operations/repos/add-protected-branch-required-signatures.json index 95206ff105..dfc70c8de5 100644 --- a/openapi/api.github.com/operations/repos/add-protected-branch-required-signatures.json +++ b/openapi/api.github.com/operations/repos/add-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/add-protected-branch-required-status-checks-contexts.json b/openapi/api.github.com/operations/repos/add-protected-branch-required-status-checks-contexts.json index fbd6523ed6..216a454a4d 100644 --- a/openapi/api.github.com/operations/repos/add-protected-branch-required-status-checks-contexts.json +++ b/openapi/api.github.com/operations/repos/add-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/add-protected-branch-team-restrictions.json b/openapi/api.github.com/operations/repos/add-protected-branch-team-restrictions.json index 7ca58203d6..23d6f6d848 100644 --- a/openapi/api.github.com/operations/repos/add-protected-branch-team-restrictions.json +++ b/openapi/api.github.com/operations/repos/add-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/add-protected-branch-user-restrictions.json b/openapi/api.github.com/operations/repos/add-protected-branch-user-restrictions.json index f772c8d726..ca6dd5dd8c 100644 --- a/openapi/api.github.com/operations/repos/add-protected-branch-user-restrictions.json +++ b/openapi/api.github.com/operations/repos/add-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/check-collaborator.json b/openapi/api.github.com/operations/repos/check-collaborator.json index b2fcce20ba..6d0710b83b 100644 --- a/openapi/api.github.com/operations/repos/check-collaborator.json +++ b/openapi/api.github.com/operations/repos/check-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/check-vulnerability-alerts.json b/openapi/api.github.com/operations/repos/check-vulnerability-alerts.json index cbedbcc0ea..d3a3191aff 100644 --- a/openapi/api.github.com/operations/repos/check-vulnerability-alerts.json +++ b/openapi/api.github.com/operations/repos/check-vulnerability-alerts.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/compare-commits.json b/openapi/api.github.com/operations/repos/compare-commits.json index fa605c7766..00ea58e9ae 100644 --- a/openapi/api.github.com/operations/repos/compare-commits.json +++ b/openapi/api.github.com/operations/repos/compare-commits.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "base", + "description": "base parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "base parameter" + } }, { "name": "head", + "description": "head parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "head parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/create-commit-comment.json b/openapi/api.github.com/operations/repos/create-commit-comment.json index e4c26a0767..8d4b82b74d 100644 --- a/openapi/api.github.com/operations/repos/create-commit-comment.json +++ b/openapi/api.github.com/operations/repos/create-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { @@ -187,20 +187,20 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." }, "path": { - "description": "Relative path of the file to comment on.", - "type": "string" + "type": "string", + "description": "Relative path of the file to comment on." }, "position": { - "description": "Line index in the diff to comment on.", - "type": "integer" + "type": "integer", + "description": "Line index in the diff to comment on." }, "line": { - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "type": "integer" + "type": "integer", + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/create-deployment-status.json b/openapi/api.github.com/operations/repos/create-deployment-status.json index ede0fca9ec..3e9ee7c791 100644 --- a/openapi/api.github.com/operations/repos/create-deployment-status.json +++ b/openapi/api.github.com/operations/repos/create-deployment-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { @@ -182,8 +182,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", "enum": [ "error", "failure", @@ -195,23 +195,23 @@ ] }, "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", + "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": "" }, "log_url": { - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", "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: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", "default": "" }, "description": { - "description": "A short description of the status. The maximum description length is 140 characters.", "type": "string", + "description": "A short description of the status. The maximum description length is 140 characters.", "default": "" }, "environment": { - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", "type": "string", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", "enum": [ "production", "staging", @@ -219,13 +219,13 @@ ] }, "environment_url": { - "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", "type": "string", + "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", "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. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "type": "boolean" + "type": "boolean", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type." } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/create-deployment.json b/openapi/api.github.com/operations/repos/create-deployment.json index ba3e8106ec..9e1da5e616 100644 --- a/openapi/api.github.com/operations/repos/create-deployment.json +++ b/openapi/api.github.com/operations/repos/create-deployment.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,49 +66,49 @@ "type": "object", "properties": { "ref": { - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "type": "string" + "type": "string", + "description": "The ref to deploy. This can be a branch, tag, or SHA." }, "task": { - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "type": "string", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "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", + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", "default": true }, "required_contexts": { - "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "type": "array", + "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "items": { "type": "string" } }, "payload": { - "description": "JSON payload with extra information about the deployment.", "type": "string", + "description": "JSON payload with extra information about the deployment.", "default": "" }, "environment": { - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "type": "string", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "default": "production" }, "description": { - "description": "Short description of the deployment.", "type": "string", + "description": "Short description of the deployment.", "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. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", "type": "boolean", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", "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. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", - "type": "boolean" + "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. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type." } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/create-for-authenticated-user.json b/openapi/api.github.com/operations/repos/create-for-authenticated-user.json index f7436b35bb..99ffea466e 100644 --- a/openapi/api.github.com/operations/repos/create-for-authenticated-user.json +++ b/openapi/api.github.com/operations/repos/create-for-authenticated-user.json @@ -361,72 +361,72 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "default": true }, "is_template": { - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "default": false }, "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/api.github.com/operations/repos/create-fork.json b/openapi/api.github.com/operations/repos/create-fork.json index 9088c401c1..c7ee3d0aa5 100644 --- a/openapi/api.github.com/operations/repos/create-fork.json +++ b/openapi/api.github.com/operations/repos/create-fork.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -379,8 +379,8 @@ "type": "object", "properties": { "organization": { - "description": "Optional parameter to specify the organization name if forking into an organization.", - "type": "string" + "type": "string", + "description": "Optional parameter to specify the organization name if forking into an organization." } } } diff --git a/openapi/api.github.com/operations/repos/create-hook.json b/openapi/api.github.com/operations/repos/create-hook.json index 1028539c59..3c5ddce5cc 100644 --- a/openapi/api.github.com/operations/repos/create-hook.json +++ b/openapi/api.github.com/operations/repos/create-hook.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -136,28 +136,28 @@ "type": "object", "properties": { "name": { - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "type": "string" + "type": "string", + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "secret": { - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -165,8 +165,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -175,8 +175,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/api.github.com/operations/repos/create-in-org.json b/openapi/api.github.com/operations/repos/create-in-org.json index 260e941425..7092271d55 100644 --- a/openapi/api.github.com/operations/repos/create-in-org.json +++ b/openapi/api.github.com/operations/repos/create-in-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -370,72 +370,72 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "default": true }, "is_template": { - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "default": false }, "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/api.github.com/operations/repos/create-or-update-file.json b/openapi/api.github.com/operations/repos/create-or-update-file.json index cdeb78116e..a1b9825db3 100644 --- a/openapi/api.github.com/operations/repos/create-or-update-file.json +++ b/openapi/api.github.com/operations/repos/create-or-update-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -250,32 +250,32 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "content": { - "description": "The new file content, using Base64 encoding.", - "type": "string" + "type": "string", + "description": "The new file content, using Base64 encoding." }, "sha": { - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "The person that committed the file. Default: the authenticated user.", "type": "object", + "description": "The person that committed the file. Default: the authenticated user.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ @@ -284,16 +284,16 @@ ] }, "author": { - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "type": "object", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/create-release.json b/openapi/api.github.com/operations/repos/create-release.json index 3718437ef3..79dba5bacf 100644 --- a/openapi/api.github.com/operations/repos/create-release.json +++ b/openapi/api.github.com/operations/repos/create-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -187,29 +187,29 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "type": "boolean", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "default": false }, "prerelease": { - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "type": "boolean", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "default": false } }, diff --git a/openapi/api.github.com/operations/repos/create-status.json b/openapi/api.github.com/operations/repos/create-status.json index 314b99133e..97d4da160d 100644 --- a/openapi/api.github.com/operations/repos/create-status.json +++ b/openapi/api.github.com/operations/repos/create-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { @@ -173,8 +173,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "enum": [ "error", "failure", @@ -183,16 +183,16 @@ ] }, "target_url": { - "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "type": "string" + "type": "string", + "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`" }, "description": { - "description": "A short description of the status.", - "type": "string" + "type": "string", + "description": "A short description of the status." }, "context": { - "description": "A string label to differentiate this status from the status of other systems.", "type": "string", + "description": "A string label to differentiate this status from the status of other systems.", "default": "default" } }, diff --git a/openapi/api.github.com/operations/repos/create-using-template.json b/openapi/api.github.com/operations/repos/create-using-template.json index 70d060d288..8caa8d44de 100644 --- a/openapi/api.github.com/operations/repos/create-using-template.json +++ b/openapi/api.github.com/operations/repos/create-using-template.json @@ -22,21 +22,21 @@ }, { "name": "template_owner", + "description": "template_owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "template_owner parameter" + } }, { "name": "template_repo", + "description": "template_repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "template_repo parameter" + } } ], "responses": { @@ -686,20 +686,20 @@ "type": "object", "properties": { "owner": { - "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "type": "string" + "type": "string", + "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization." }, "name": { - "description": "The name of the new repository.", - "type": "string" + "type": "string", + "description": "The name of the new repository." }, "description": { - "description": "A short description of the new repository.", - "type": "string" + "type": "string", + "description": "A short description of the new repository." }, "private": { - "description": "Either `true` to create a new private repository or `false` to create a new public one.", "type": "boolean", + "description": "Either `true` to create a new private repository or `false` to create a new public one.", "default": false } }, diff --git a/openapi/api.github.com/operations/repos/decline-invitation.json b/openapi/api.github.com/operations/repos/decline-invitation.json index 2e481598c0..6dfbd297a2 100644 --- a/openapi/api.github.com/operations/repos/decline-invitation.json +++ b/openapi/api.github.com/operations/repos/decline-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete-commit-comment.json b/openapi/api.github.com/operations/repos/delete-commit-comment.json index bbbfb4d6e7..82db63f46b 100644 --- a/openapi/api.github.com/operations/repos/delete-commit-comment.json +++ b/openapi/api.github.com/operations/repos/delete-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete-download.json b/openapi/api.github.com/operations/repos/delete-download.json index c0aa7edcc1..ce40133af4 100644 --- a/openapi/api.github.com/operations/repos/delete-download.json +++ b/openapi/api.github.com/operations/repos/delete-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete-file.json b/openapi/api.github.com/operations/repos/delete-file.json index b3a1d73c63..ba7cf144a7 100644 --- a/openapi/api.github.com/operations/repos/delete-file.json +++ b/openapi/api.github.com/operations/repos/delete-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -180,42 +180,42 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "sha": { - "description": "The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "object containing information about the committer.", "type": "object", + "description": "object containing information about the committer.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } }, "author": { - "description": "object containing information about the author.", "type": "object", + "description": "object containing information about the author.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } } diff --git a/openapi/api.github.com/operations/repos/delete-hook.json b/openapi/api.github.com/operations/repos/delete-hook.json index 0f16aed29a..9b442d3d49 100644 --- a/openapi/api.github.com/operations/repos/delete-hook.json +++ b/openapi/api.github.com/operations/repos/delete-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete-invitation.json b/openapi/api.github.com/operations/repos/delete-invitation.json index 40ccad6b59..6c02e53522 100644 --- a/openapi/api.github.com/operations/repos/delete-invitation.json +++ b/openapi/api.github.com/operations/repos/delete-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete-release-asset.json b/openapi/api.github.com/operations/repos/delete-release-asset.json index 60302793ac..4b4f42668f 100644 --- a/openapi/api.github.com/operations/repos/delete-release-asset.json +++ b/openapi/api.github.com/operations/repos/delete-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete-release.json b/openapi/api.github.com/operations/repos/delete-release.json index ff329cbeda..5a21a82d54 100644 --- a/openapi/api.github.com/operations/repos/delete-release.json +++ b/openapi/api.github.com/operations/repos/delete-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/delete.json b/openapi/api.github.com/operations/repos/delete.json index 881fc85b31..d65e4d2532 100644 --- a/openapi/api.github.com/operations/repos/delete.json +++ b/openapi/api.github.com/operations/repos/delete.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/disable-automated-security-fixes.json b/openapi/api.github.com/operations/repos/disable-automated-security-fixes.json index 8aa48e0396..d203e16c1c 100644 --- a/openapi/api.github.com/operations/repos/disable-automated-security-fixes.json +++ b/openapi/api.github.com/operations/repos/disable-automated-security-fixes.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/disable-pages-site.json b/openapi/api.github.com/operations/repos/disable-pages-site.json index 1d73d8cbbe..069e43883d 100644 --- a/openapi/api.github.com/operations/repos/disable-pages-site.json +++ b/openapi/api.github.com/operations/repos/disable-pages-site.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/disable-vulnerability-alerts.json b/openapi/api.github.com/operations/repos/disable-vulnerability-alerts.json index 812aec8338..9aa01a6adf 100644 --- a/openapi/api.github.com/operations/repos/disable-vulnerability-alerts.json +++ b/openapi/api.github.com/operations/repos/disable-vulnerability-alerts.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/enable-automated-security-fixes.json b/openapi/api.github.com/operations/repos/enable-automated-security-fixes.json index b437c38089..49e3a7893c 100644 --- a/openapi/api.github.com/operations/repos/enable-automated-security-fixes.json +++ b/openapi/api.github.com/operations/repos/enable-automated-security-fixes.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/enable-pages-site.json b/openapi/api.github.com/operations/repos/enable-pages-site.json index 42ff1c6bb5..e1c492f3b5 100644 --- a/openapi/api.github.com/operations/repos/enable-pages-site.json +++ b/openapi/api.github.com/operations/repos/enable-pages-site.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -102,20 +102,20 @@ "type": "object", "properties": { "source": { - "description": "source parameter", "type": "object", + "description": "source parameter", "properties": { "branch": { - "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", "type": "string", + "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", "enum": [ "master", "gh-pages" ] }, "path": { - "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", - "type": "string" + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`." } } } diff --git a/openapi/api.github.com/operations/repos/enable-vulnerability-alerts.json b/openapi/api.github.com/operations/repos/enable-vulnerability-alerts.json index 42119622e4..ee4a88443e 100644 --- a/openapi/api.github.com/operations/repos/enable-vulnerability-alerts.json +++ b/openapi/api.github.com/operations/repos/enable-vulnerability-alerts.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-archive-link.json b/openapi/api.github.com/operations/repos/get-archive-link.json index 38d5c00773..f32bf1cc2b 100644 --- a/openapi/api.github.com/operations/repos/get-archive-link.json +++ b/openapi/api.github.com/operations/repos/get-archive-link.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "archive_format", + "description": "archive_format parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "archive_format parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-branch-protection.json b/openapi/api.github.com/operations/repos/get-branch-protection.json index e6a9083d77..773d751f03 100644 --- a/openapi/api.github.com/operations/repos/get-branch-protection.json +++ b/openapi/api.github.com/operations/repos/get-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-branch.json b/openapi/api.github.com/operations/repos/get-branch.json index 784051d512..3598db6cd3 100644 --- a/openapi/api.github.com/operations/repos/get-branch.json +++ b/openapi/api.github.com/operations/repos/get-branch.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-clones.json b/openapi/api.github.com/operations/repos/get-clones.json index bbca2b4fd0..4378ab86d1 100644 --- a/openapi/api.github.com/operations/repos/get-clones.json +++ b/openapi/api.github.com/operations/repos/get-clones.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per", + "description": "Must be one of: `day`, `week`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,9 +49,7 @@ "week" ], "default": "day" - }, - "required": false, - "description": "Must be one of: `day`, `week`." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-code-frequency-stats.json b/openapi/api.github.com/operations/repos/get-code-frequency-stats.json index f63e1c5503..009853ea6d 100644 --- a/openapi/api.github.com/operations/repos/get-code-frequency-stats.json +++ b/openapi/api.github.com/operations/repos/get-code-frequency-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-collaborator-permission-level.json b/openapi/api.github.com/operations/repos/get-collaborator-permission-level.json index 21ef575c95..2e5a701f9d 100644 --- a/openapi/api.github.com/operations/repos/get-collaborator-permission-level.json +++ b/openapi/api.github.com/operations/repos/get-collaborator-permission-level.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-combined-status-for-ref.json b/openapi/api.github.com/operations/repos/get-combined-status-for-ref.json index c566a5dd8f..3dedfa8d74 100644 --- a/openapi/api.github.com/operations/repos/get-combined-status-for-ref.json +++ b/openapi/api.github.com/operations/repos/get-combined-status-for-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-commit-activity-stats.json b/openapi/api.github.com/operations/repos/get-commit-activity-stats.json index a94245b45b..dcbfc34907 100644 --- a/openapi/api.github.com/operations/repos/get-commit-activity-stats.json +++ b/openapi/api.github.com/operations/repos/get-commit-activity-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-commit-comment.json b/openapi/api.github.com/operations/repos/get-commit-comment.json index 78457a4d7c..f49602f68b 100644 --- a/openapi/api.github.com/operations/repos/get-commit-comment.json +++ b/openapi/api.github.com/operations/repos/get-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-commit.json b/openapi/api.github.com/operations/repos/get-commit.json index 4995e15e05..d17d93f549 100644 --- a/openapi/api.github.com/operations/repos/get-commit.json +++ b/openapi/api.github.com/operations/repos/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-contents.json b/openapi/api.github.com/operations/repos/get-contents.json index 1b55512770..63cb51c12b 100644 --- a/openapi/api.github.com/operations/repos/get-contents.json +++ b/openapi/api.github.com/operations/repos/get-contents.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-contributors-stats.json b/openapi/api.github.com/operations/repos/get-contributors-stats.json index 624a5362cf..e2626619d7 100644 --- a/openapi/api.github.com/operations/repos/get-contributors-stats.json +++ b/openapi/api.github.com/operations/repos/get-contributors-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-deploy-key.json b/openapi/api.github.com/operations/repos/get-deploy-key.json index 5b30564d3e..babe302174 100644 --- a/openapi/api.github.com/operations/repos/get-deploy-key.json +++ b/openapi/api.github.com/operations/repos/get-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-deployment-status.json b/openapi/api.github.com/operations/repos/get-deployment-status.json index 7f8fcf6788..3ef2309e0f 100644 --- a/openapi/api.github.com/operations/repos/get-deployment-status.json +++ b/openapi/api.github.com/operations/repos/get-deployment-status.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "status_id", + "description": "status_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "status_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-deployment.json b/openapi/api.github.com/operations/repos/get-deployment.json index 49726c5b46..242ee2a822 100644 --- a/openapi/api.github.com/operations/repos/get-deployment.json +++ b/openapi/api.github.com/operations/repos/get-deployment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-download.json b/openapi/api.github.com/operations/repos/get-download.json index 5240a48113..da4190024f 100644 --- a/openapi/api.github.com/operations/repos/get-download.json +++ b/openapi/api.github.com/operations/repos/get-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-hook.json b/openapi/api.github.com/operations/repos/get-hook.json index 431f6ca6e2..ff4289f532 100644 --- a/openapi/api.github.com/operations/repos/get-hook.json +++ b/openapi/api.github.com/operations/repos/get-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-latest-pages-build.json b/openapi/api.github.com/operations/repos/get-latest-pages-build.json index 4c9da8ea86..058396612e 100644 --- a/openapi/api.github.com/operations/repos/get-latest-pages-build.json +++ b/openapi/api.github.com/operations/repos/get-latest-pages-build.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-latest-release.json b/openapi/api.github.com/operations/repos/get-latest-release.json index 4f18d1b683..78f716e835 100644 --- a/openapi/api.github.com/operations/repos/get-latest-release.json +++ b/openapi/api.github.com/operations/repos/get-latest-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-pages-build.json b/openapi/api.github.com/operations/repos/get-pages-build.json index 5c5057ad91..f9e3144a96 100644 --- a/openapi/api.github.com/operations/repos/get-pages-build.json +++ b/openapi/api.github.com/operations/repos/get-pages-build.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "build_id", + "description": "build_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "build_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-pages.json b/openapi/api.github.com/operations/repos/get-pages.json index 8f64fa30f4..0bfb5305e2 100644 --- a/openapi/api.github.com/operations/repos/get-pages.json +++ b/openapi/api.github.com/operations/repos/get-pages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-participation-stats.json b/openapi/api.github.com/operations/repos/get-participation-stats.json index 34d7d72d27..bf81c9f18c 100644 --- a/openapi/api.github.com/operations/repos/get-participation-stats.json +++ b/openapi/api.github.com/operations/repos/get-participation-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-protected-branch-admin-enforcement.json b/openapi/api.github.com/operations/repos/get-protected-branch-admin-enforcement.json index b536818f7c..a6d987dbee 100644 --- a/openapi/api.github.com/operations/repos/get-protected-branch-admin-enforcement.json +++ b/openapi/api.github.com/operations/repos/get-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-protected-branch-pull-request-review-enforcement.json b/openapi/api.github.com/operations/repos/get-protected-branch-pull-request-review-enforcement.json index c48223a8b4..7527705b60 100644 --- a/openapi/api.github.com/operations/repos/get-protected-branch-pull-request-review-enforcement.json +++ b/openapi/api.github.com/operations/repos/get-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-protected-branch-required-signatures.json b/openapi/api.github.com/operations/repos/get-protected-branch-required-signatures.json index 5e19c453e5..cb22415612 100644 --- a/openapi/api.github.com/operations/repos/get-protected-branch-required-signatures.json +++ b/openapi/api.github.com/operations/repos/get-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-protected-branch-required-status-checks.json b/openapi/api.github.com/operations/repos/get-protected-branch-required-status-checks.json index 25cc050ae2..59da0b0b89 100644 --- a/openapi/api.github.com/operations/repos/get-protected-branch-required-status-checks.json +++ b/openapi/api.github.com/operations/repos/get-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-protected-branch-restrictions.json b/openapi/api.github.com/operations/repos/get-protected-branch-restrictions.json index 4a20d680f0..0e7e7168fc 100644 --- a/openapi/api.github.com/operations/repos/get-protected-branch-restrictions.json +++ b/openapi/api.github.com/operations/repos/get-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-punch-card-stats.json b/openapi/api.github.com/operations/repos/get-punch-card-stats.json index 86ff240695..076c621bc1 100644 --- a/openapi/api.github.com/operations/repos/get-punch-card-stats.json +++ b/openapi/api.github.com/operations/repos/get-punch-card-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-readme.json b/openapi/api.github.com/operations/repos/get-readme.json index b27f82be1f..559cf2a298 100644 --- a/openapi/api.github.com/operations/repos/get-readme.json +++ b/openapi/api.github.com/operations/repos/get-readme.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-release-asset.json b/openapi/api.github.com/operations/repos/get-release-asset.json index 113ff788c5..2216e7d77e 100644 --- a/openapi/api.github.com/operations/repos/get-release-asset.json +++ b/openapi/api.github.com/operations/repos/get-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-release-by-tag.json b/openapi/api.github.com/operations/repos/get-release-by-tag.json index 98c3c1f92b..d8638e32e9 100644 --- a/openapi/api.github.com/operations/repos/get-release-by-tag.json +++ b/openapi/api.github.com/operations/repos/get-release-by-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag", + "description": "tag parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-release.json b/openapi/api.github.com/operations/repos/get-release.json index 9e98e0d44e..79ddb594a7 100644 --- a/openapi/api.github.com/operations/repos/get-release.json +++ b/openapi/api.github.com/operations/repos/get-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-top-paths.json b/openapi/api.github.com/operations/repos/get-top-paths.json index 20c30c0c40..76ac36eb7e 100644 --- a/openapi/api.github.com/operations/repos/get-top-paths.json +++ b/openapi/api.github.com/operations/repos/get-top-paths.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-top-referrers.json b/openapi/api.github.com/operations/repos/get-top-referrers.json index ff01b1ea0d..72a1d92b46 100644 --- a/openapi/api.github.com/operations/repos/get-top-referrers.json +++ b/openapi/api.github.com/operations/repos/get-top-referrers.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get-views.json b/openapi/api.github.com/operations/repos/get-views.json index 0fa3e3f96f..8572ec7b76 100644 --- a/openapi/api.github.com/operations/repos/get-views.json +++ b/openapi/api.github.com/operations/repos/get-views.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per", + "description": "Must be one of: `day`, `week`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,9 +49,7 @@ "week" ], "default": "day" - }, - "required": false, - "description": "Must be one of: `day`, `week`." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/get.json b/openapi/api.github.com/operations/repos/get.json index 0aefcc9056..c237b740be 100644 --- a/openapi/api.github.com/operations/repos/get.json +++ b/openapi/api.github.com/operations/repos/get.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-assets-for-release.json b/openapi/api.github.com/operations/repos/list-assets-for-release.json index 1a14a40f2a..e083b6497a 100644 --- a/openapi/api.github.com/operations/repos/list-assets-for-release.json +++ b/openapi/api.github.com/operations/repos/list-assets-for-release.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-branches-for-head-commit.json b/openapi/api.github.com/operations/repos/list-branches-for-head-commit.json index e5166bc254..b46e21bf21 100644 --- a/openapi/api.github.com/operations/repos/list-branches-for-head-commit.json +++ b/openapi/api.github.com/operations/repos/list-branches-for-head-commit.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-branches.json b/openapi/api.github.com/operations/repos/list-branches.json index 4b52eba35d..09e07691ed 100644 --- a/openapi/api.github.com/operations/repos/list-branches.json +++ b/openapi/api.github.com/operations/repos/list-branches.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "protected", + "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", + "required": false, "schema": { "type": "boolean" - }, - "required": false, - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-collaborators.json b/openapi/api.github.com/operations/repos/list-collaborators.json index b05d8dadfb..b8dcd198f0 100644 --- a/openapi/api.github.com/operations/repos/list-collaborators.json +++ b/openapi/api.github.com/operations/repos/list-collaborators.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-comments-for-commit.json b/openapi/api.github.com/operations/repos/list-comments-for-commit.json index 7b34bd1358..3d2f413be3 100644 --- a/openapi/api.github.com/operations/repos/list-comments-for-commit.json +++ b/openapi/api.github.com/operations/repos/list-comments-for-commit.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-commit-comments.json b/openapi/api.github.com/operations/repos/list-commit-comments.json index c9a675a571..c7cbb7c9cf 100644 --- a/openapi/api.github.com/operations/repos/list-commit-comments.json +++ b/openapi/api.github.com/operations/repos/list-commit-comments.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-commits.json b/openapi/api.github.com/operations/repos/list-commits.json index 97e35bea7d..223f0e01bf 100644 --- a/openapi/api.github.com/operations/repos/list-commits.json +++ b/openapi/api.github.com/operations/repos/list-commits.json @@ -21,86 +21,84 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`)." + } }, { "name": "path", + "description": "Only commits containing this file path will be returned.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Only commits containing this file path will be returned." + } }, { "name": "author", + "description": "GitHub login or email address by which to filter by commit author.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "GitHub login or email address by which to filter by commit author." + } }, { "name": "since", + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-contributors.json b/openapi/api.github.com/operations/repos/list-contributors.json index 8bad740b82..8881602ae0 100644 --- a/openapi/api.github.com/operations/repos/list-contributors.json +++ b/openapi/api.github.com/operations/repos/list-contributors.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Set to `1` or `true` to include anonymous contributors in results." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-deploy-keys.json b/openapi/api.github.com/operations/repos/list-deploy-keys.json index c08286bf6b..f2db0d8692 100644 --- a/openapi/api.github.com/operations/repos/list-deploy-keys.json +++ b/openapi/api.github.com/operations/repos/list-deploy-keys.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-deployment-statuses.json b/openapi/api.github.com/operations/repos/list-deployment-statuses.json index cac130b4b6..ed1ee87ca8 100644 --- a/openapi/api.github.com/operations/repos/list-deployment-statuses.json +++ b/openapi/api.github.com/operations/repos/list-deployment-statuses.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-deployments.json b/openapi/api.github.com/operations/repos/list-deployments.json index 2aa5cafcff..72b72a1b84 100644 --- a/openapi/api.github.com/operations/repos/list-deployments.json +++ b/openapi/api.github.com/operations/repos/list-deployments.json @@ -21,81 +21,79 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "The SHA recorded at creation time.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The SHA recorded at creation time." + } }, { "name": "ref", + "description": "The name of the ref. This can be a branch, tag, or SHA.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the ref. This can be a branch, tag, or SHA." + } }, { "name": "task", + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`)." + } }, { "name": "environment", + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-downloads.json b/openapi/api.github.com/operations/repos/list-downloads.json index a2ad97634b..e34c109bfa 100644 --- a/openapi/api.github.com/operations/repos/list-downloads.json +++ b/openapi/api.github.com/operations/repos/list-downloads.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-for-org.json b/openapi/api.github.com/operations/repos/list-for-org.json index a23aa91ddb..f47c9ae8c1 100644 --- a/openapi/api.github.com/operations/repos/list-for-org.json +++ b/openapi/api.github.com/operations/repos/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -42,13 +44,13 @@ "member" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`." + } }, { "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -58,42 +60,38 @@ "full_name" ], "default": "created" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-for-user.json b/openapi/api.github.com/operations/repos/list-for-user.json index 44ad4989c1..fd52041a71 100644 --- a/openapi/api.github.com/operations/repos/list-for-user.json +++ b/openapi/api.github.com/operations/repos/list-for-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `owner`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "member" ], "default": "owner" - }, - "required": false, - "description": "Can be one of `all`, `owner`, `member`." + } }, { "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -55,42 +57,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-forks.json b/openapi/api.github.com/operations/repos/list-forks.json index 0f6370a974..7b1c26a15b 100644 --- a/openapi/api.github.com/operations/repos/list-forks.json +++ b/openapi/api.github.com/operations/repos/list-forks.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "stargazers" ], "default": "newest" - }, - "required": false, - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-hooks.json b/openapi/api.github.com/operations/repos/list-hooks.json index 2749418ac6..88ed0c6903 100644 --- a/openapi/api.github.com/operations/repos/list-hooks.json +++ b/openapi/api.github.com/operations/repos/list-hooks.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-invitations-for-authenticated-user.json b/openapi/api.github.com/operations/repos/list-invitations-for-authenticated-user.json index 6268cda52b..0f6d01258a 100644 --- a/openapi/api.github.com/operations/repos/list-invitations-for-authenticated-user.json +++ b/openapi/api.github.com/operations/repos/list-invitations-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-invitations.json b/openapi/api.github.com/operations/repos/list-invitations.json index b6b627b082..b4e4d9e7cd 100644 --- a/openapi/api.github.com/operations/repos/list-invitations.json +++ b/openapi/api.github.com/operations/repos/list-invitations.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-languages.json b/openapi/api.github.com/operations/repos/list-languages.json index 8298abdf7b..eb6c31539e 100644 --- a/openapi/api.github.com/operations/repos/list-languages.json +++ b/openapi/api.github.com/operations/repos/list-languages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-pages-builds.json b/openapi/api.github.com/operations/repos/list-pages-builds.json index bdbfea6cf8..42bbde7916 100644 --- a/openapi/api.github.com/operations/repos/list-pages-builds.json +++ b/openapi/api.github.com/operations/repos/list-pages-builds.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-protected-branch-required-status-checks-contexts.json b/openapi/api.github.com/operations/repos/list-protected-branch-required-status-checks-contexts.json index c0980f0d70..de06dea75c 100644 --- a/openapi/api.github.com/operations/repos/list-protected-branch-required-status-checks-contexts.json +++ b/openapi/api.github.com/operations/repos/list-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-protected-branch-team-restrictions.json b/openapi/api.github.com/operations/repos/list-protected-branch-team-restrictions.json index d03146a6d9..5e2cea7c9c 100644 --- a/openapi/api.github.com/operations/repos/list-protected-branch-team-restrictions.json +++ b/openapi/api.github.com/operations/repos/list-protected-branch-team-restrictions.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-protected-branch-user-restrictions.json b/openapi/api.github.com/operations/repos/list-protected-branch-user-restrictions.json index 8878425003..8d9a69838c 100644 --- a/openapi/api.github.com/operations/repos/list-protected-branch-user-restrictions.json +++ b/openapi/api.github.com/operations/repos/list-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-public.json b/openapi/api.github.com/operations/repos/list-public.json index 2d8791bcba..10ca279b8d 100644 --- a/openapi/api.github.com/operations/repos/list-public.json +++ b/openapi/api.github.com/operations/repos/list-public.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last Repository that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Repository that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-pull-requests-associated-with-commit.json b/openapi/api.github.com/operations/repos/list-pull-requests-associated-with-commit.json index 12fdbae070..738304c6d7 100644 --- a/openapi/api.github.com/operations/repos/list-pull-requests-associated-with-commit.json +++ b/openapi/api.github.com/operations/repos/list-pull-requests-associated-with-commit.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-releases.json b/openapi/api.github.com/operations/repos/list-releases.json index ccc2074ddd..e5f386fa5b 100644 --- a/openapi/api.github.com/operations/repos/list-releases.json +++ b/openapi/api.github.com/operations/repos/list-releases.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-statuses-for-ref.json b/openapi/api.github.com/operations/repos/list-statuses-for-ref.json index 9106c52e9e..bc1a98ca7e 100644 --- a/openapi/api.github.com/operations/repos/list-statuses-for-ref.json +++ b/openapi/api.github.com/operations/repos/list-statuses-for-ref.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-tags.json b/openapi/api.github.com/operations/repos/list-tags.json index 93d085a3da..63e7bab17c 100644 --- a/openapi/api.github.com/operations/repos/list-tags.json +++ b/openapi/api.github.com/operations/repos/list-tags.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-teams.json b/openapi/api.github.com/operations/repos/list-teams.json index 18cc3edda3..2d1058d0e1 100644 --- a/openapi/api.github.com/operations/repos/list-teams.json +++ b/openapi/api.github.com/operations/repos/list-teams.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list-topics.json b/openapi/api.github.com/operations/repos/list-topics.json index 6ee24b1c44..4767a0c608 100644 --- a/openapi/api.github.com/operations/repos/list-topics.json +++ b/openapi/api.github.com/operations/repos/list-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/list.json b/openapi/api.github.com/operations/repos/list.json index ac1c98a96e..781acc389f 100644 --- a/openapi/api.github.com/operations/repos/list.json +++ b/openapi/api.github.com/operations/repos/list.json @@ -21,7 +21,9 @@ }, { "name": "visibility", + "description": "Can be one of `all`, `public`, or `private`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -30,23 +32,23 @@ "private" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, or `private`." + } }, { "name": "affiliation", + "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.", "in": "query", + "required": false, "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", + "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**.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,13 +59,13 @@ "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", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -73,42 +75,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/merge.json b/openapi/api.github.com/operations/repos/merge.json index 54fd250e2c..5baac85908 100644 --- a/openapi/api.github.com/operations/repos/merge.json +++ b/openapi/api.github.com/operations/repos/merge.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,16 +66,16 @@ "type": "object", "properties": { "base": { - "description": "The name of the base branch that the head will be merged into.", - "type": "string" + "type": "string", + "description": "The name of the base branch that the head will be merged into." }, "head": { - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "type": "string" + "type": "string", + "description": "The head to merge. This can be a branch name or a commit SHA1." }, "commit_message": { - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "type": "string" + "type": "string", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used." } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/ping-hook.json b/openapi/api.github.com/operations/repos/ping-hook.json index e9239fac30..4cad85e2ec 100644 --- a/openapi/api.github.com/operations/repos/ping-hook.json +++ b/openapi/api.github.com/operations/repos/ping-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-branch-protection.json b/openapi/api.github.com/operations/repos/remove-branch-protection.json index f02d39a6a2..528fbc693c 100644 --- a/openapi/api.github.com/operations/repos/remove-branch-protection.json +++ b/openapi/api.github.com/operations/repos/remove-branch-protection.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-collaborator.json b/openapi/api.github.com/operations/repos/remove-collaborator.json index 9d30622805..88ac3f8da9 100644 --- a/openapi/api.github.com/operations/repos/remove-collaborator.json +++ b/openapi/api.github.com/operations/repos/remove-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-deploy-key.json b/openapi/api.github.com/operations/repos/remove-deploy-key.json index c38be22240..523a6f7439 100644 --- a/openapi/api.github.com/operations/repos/remove-deploy-key.json +++ b/openapi/api.github.com/operations/repos/remove-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-admin-enforcement.json b/openapi/api.github.com/operations/repos/remove-protected-branch-admin-enforcement.json index 1de60eefa2..33c2907b62 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-admin-enforcement.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-pull-request-review-enforcement.json b/openapi/api.github.com/operations/repos/remove-protected-branch-pull-request-review-enforcement.json index 40d0ef25b1..65f126a864 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-pull-request-review-enforcement.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-pull-request-review-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-required-signatures.json b/openapi/api.github.com/operations/repos/remove-protected-branch-required-signatures.json index 30408b53c5..7eaa49d6a6 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-required-signatures.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks-contexts.json b/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks-contexts.json index 759af78db9..20052232e3 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks-contexts.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks.json b/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks.json index cafee21fdb..35e668185c 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-restrictions.json b/openapi/api.github.com/operations/repos/remove-protected-branch-restrictions.json index 4fbf480a2c..210fce2552 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-restrictions.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-team-restrictions.json b/openapi/api.github.com/operations/repos/remove-protected-branch-team-restrictions.json index 950f4881e0..857e0552f2 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-team-restrictions.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/remove-protected-branch-user-restrictions.json b/openapi/api.github.com/operations/repos/remove-protected-branch-user-restrictions.json index 175fae952f..51d0d096bd 100644 --- a/openapi/api.github.com/operations/repos/remove-protected-branch-user-restrictions.json +++ b/openapi/api.github.com/operations/repos/remove-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/replace-protected-branch-required-status-checks-contexts.json b/openapi/api.github.com/operations/repos/replace-protected-branch-required-status-checks-contexts.json index af1ee2168b..d05f480f3c 100644 --- a/openapi/api.github.com/operations/repos/replace-protected-branch-required-status-checks-contexts.json +++ b/openapi/api.github.com/operations/repos/replace-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/replace-protected-branch-team-restrictions.json b/openapi/api.github.com/operations/repos/replace-protected-branch-team-restrictions.json index a02a1a615f..a5c98c0ebd 100644 --- a/openapi/api.github.com/operations/repos/replace-protected-branch-team-restrictions.json +++ b/openapi/api.github.com/operations/repos/replace-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/replace-protected-branch-user-restrictions.json b/openapi/api.github.com/operations/repos/replace-protected-branch-user-restrictions.json index 093a03fb41..b0c74638ae 100644 --- a/openapi/api.github.com/operations/repos/replace-protected-branch-user-restrictions.json +++ b/openapi/api.github.com/operations/repos/replace-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/api.github.com/operations/repos/replace-topics.json b/openapi/api.github.com/operations/repos/replace-topics.json index 5ce16a84d9..884ab8c446 100644 --- a/openapi/api.github.com/operations/repos/replace-topics.json +++ b/openapi/api.github.com/operations/repos/replace-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,8 +81,8 @@ "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", + "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.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/repos/request-page-build.json b/openapi/api.github.com/operations/repos/request-page-build.json index 26cbbd73ce..a28f754dad 100644 --- a/openapi/api.github.com/operations/repos/request-page-build.json +++ b/openapi/api.github.com/operations/repos/request-page-build.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/retrieve-community-profile-metrics.json b/openapi/api.github.com/operations/repos/retrieve-community-profile-metrics.json index a85af77425..1abdfe9330 100644 --- a/openapi/api.github.com/operations/repos/retrieve-community-profile-metrics.json +++ b/openapi/api.github.com/operations/repos/retrieve-community-profile-metrics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/test-push-hook.json b/openapi/api.github.com/operations/repos/test-push-hook.json index ab59cf9c45..ccbdda506a 100644 --- a/openapi/api.github.com/operations/repos/test-push-hook.json +++ b/openapi/api.github.com/operations/repos/test-push-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/repos/transfer.json b/openapi/api.github.com/operations/repos/transfer.json index 8943ef9d7f..806e11e29b 100644 --- a/openapi/api.github.com/operations/repos/transfer.json +++ b/openapi/api.github.com/operations/repos/transfer.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -380,12 +380,12 @@ "type": "object", "properties": { "new_owner": { - "description": "**Required:** The username or organization name the repository will be transferred to.", - "type": "string" + "type": "string", + "description": "**Required:** The username or organization name the repository will be transferred to." }, "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", + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", "items": { "type": "integer" } diff --git a/openapi/api.github.com/operations/repos/update-branch-protection.json b/openapi/api.github.com/operations/repos/update-branch-protection.json index decb878790..0ae8146a3a 100644 --- a/openapi/api.github.com/operations/repos/update-branch-protection.json +++ b/openapi/api.github.com/operations/repos/update-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -370,17 +370,17 @@ "type": "object", "properties": { "required_status_checks": { - "description": "Require status checks to pass before merging. Set to `null` to disable.", "type": "object", + "description": "Require status checks to pass before merging. Set to `null` to disable.", "nullable": true, "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } @@ -392,29 +392,29 @@ ] }, "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", + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", "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", + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -422,34 +422,34 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them." }, "required_approving_review_count": { - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } }, "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", + "description": "Restrict who can push to this branch. Team and user `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "nullable": true, "properties": { "users": { - "description": "The list of user `login`s with push access", "type": "array", + "description": "The list of user `login`s with push access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with push access", "type": "array", + "description": "The list of team `slug`s with push access", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/repos/update-commit-comment.json b/openapi/api.github.com/operations/repos/update-commit-comment.json index 23c2dd2ab5..b44ae5e347 100644 --- a/openapi/api.github.com/operations/repos/update-commit-comment.json +++ b/openapi/api.github.com/operations/repos/update-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -176,8 +176,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment", - "type": "string" + "type": "string", + "description": "The contents of the comment" } }, "required": [ diff --git a/openapi/api.github.com/operations/repos/update-hook.json b/openapi/api.github.com/operations/repos/update-hook.json index 2c8dca366c..dc45ec9d01 100644 --- a/openapi/api.github.com/operations/repos/update-hook.json +++ b/openapi/api.github.com/operations/repos/update-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -145,24 +145,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "secret": { - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -170,8 +170,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "type": "array", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -180,22 +180,22 @@ } }, "add_events": { - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "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", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/api.github.com/operations/repos/update-information-about-pages-site.json b/openapi/api.github.com/operations/repos/update-information-about-pages-site.json index e44e12346b..b1b212b328 100644 --- a/openapi/api.github.com/operations/repos/update-information-about-pages-site.json +++ b/openapi/api.github.com/operations/repos/update-information-about-pages-site.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,12 +66,12 @@ "type": "object", "properties": { "cname": { - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "type": "string" + "type": "string", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"" }, "source": { - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "type": "string", + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "enum": [ "\"gh-pages\"", "\"master\"", diff --git a/openapi/api.github.com/operations/repos/update-invitation.json b/openapi/api.github.com/operations/repos/update-invitation.json index ea6cc51fe8..ea71444720 100644 --- a/openapi/api.github.com/operations/repos/update-invitation.json +++ b/openapi/api.github.com/operations/repos/update-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { @@ -419,8 +419,8 @@ "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", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", "enum": [ "read", "write", diff --git a/openapi/api.github.com/operations/repos/update-protected-branch-pull-request-review-enforcement.json b/openapi/api.github.com/operations/repos/update-protected-branch-pull-request-review-enforcement.json index b8188701ae..18e47f665f 100644 --- a/openapi/api.github.com/operations/repos/update-protected-branch-pull-request-review-enforcement.json +++ b/openapi/api.github.com/operations/repos/update-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -214,19 +214,19 @@ "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -234,16 +234,16 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } } diff --git a/openapi/api.github.com/operations/repos/update-protected-branch-required-status-checks.json b/openapi/api.github.com/operations/repos/update-protected-branch-required-status-checks.json index 65c9b8a9ce..66c85d8174 100644 --- a/openapi/api.github.com/operations/repos/update-protected-branch-required-status-checks.json +++ b/openapi/api.github.com/operations/repos/update-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -99,12 +99,12 @@ "type": "object", "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/repos/update-release-asset.json b/openapi/api.github.com/operations/repos/update-release-asset.json index 116155f228..26f3ee8fa9 100644 --- a/openapi/api.github.com/operations/repos/update-release-asset.json +++ b/openapi/api.github.com/operations/repos/update-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "name": { - "description": "The file name of the asset.", - "type": "string" + "type": "string", + "description": "The file name of the asset." }, "label": { - "description": "An alternate short description of the asset. Used in place of the filename.", - "type": "string" + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename." } } } diff --git a/openapi/api.github.com/operations/repos/update-release.json b/openapi/api.github.com/operations/repos/update-release.json index 63a54c3da9..5eb0fa9f06 100644 --- a/openapi/api.github.com/operations/repos/update-release.json +++ b/openapi/api.github.com/operations/repos/update-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { @@ -294,28 +294,28 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` makes the release a draft, and `false` publishes the release.", - "type": "boolean" + "type": "boolean", + "description": "`true` makes the release a draft, and `false` publishes the release." }, "prerelease": { - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "type": "boolean" + "type": "boolean", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release." } } } diff --git a/openapi/api.github.com/operations/repos/update.json b/openapi/api.github.com/operations/repos/update.json index df88898ace..cb52918896 100644 --- a/openapi/api.github.com/operations/repos/update.json +++ b/openapi/api.github.com/operations/repos/update.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1056,64 +1056,64 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "private": { - "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "type": "boolean", + "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "default": true }, "is_template": { - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "default": false }, "default_branch": { - "description": "Updates the default branch for this repository.", - "type": "string" + "type": "string", + "description": "Updates the default branch for this repository." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true }, "archived": { - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "type": "boolean", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "default": false } } diff --git a/openapi/api.github.com/operations/scim/get-provisioning-details-for-user.json b/openapi/api.github.com/operations/scim/get-provisioning-details-for-user.json index 32562ca8ea..a18342b7d5 100644 --- a/openapi/api.github.com/operations/scim/get-provisioning-details-for-user.json +++ b/openapi/api.github.com/operations/scim/get-provisioning-details-for-user.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "scim_user_id", + "description": "scim_user_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "scim_user_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/scim/list-provisioned-identities.json b/openapi/api.github.com/operations/scim/list-provisioned-identities.json index 23f67c3ec3..edf380d8f5 100644 --- a/openapi/api.github.com/operations/scim/list-provisioned-identities.json +++ b/openapi/api.github.com/operations/scim/list-provisioned-identities.json @@ -21,39 +21,39 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", "in": "query", + "required": false, "schema": { "type": "integer" - }, - "required": false, - "description": "Used for pagination: the index of the first result to return." + } }, { "name": "count", + "description": "Used for pagination: the number of results to return.", "in": "query", + "required": false, "schema": { "type": "integer" - }, - "required": false, - "description": "Used for pagination: the number of results to return." + } }, { "name": "filter", + "description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\\\"Octocat\\\"`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query: `?filter=userName%20eq%20\\\"Octocat\\\"`." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/scim/provision-and-invite-users.json b/openapi/api.github.com/operations/scim/provision-and-invite-users.json index 031a83527a..1e05338e4c 100644 --- a/openapi/api.github.com/operations/scim/provision-and-invite-users.json +++ b/openapi/api.github.com/operations/scim/provision-and-invite-users.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/scim/remove-user-from-org.json b/openapi/api.github.com/operations/scim/remove-user-from-org.json index 5f8f3a4533..73ae3ba63f 100644 --- a/openapi/api.github.com/operations/scim/remove-user-from-org.json +++ b/openapi/api.github.com/operations/scim/remove-user-from-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "scim_user_id", + "description": "scim_user_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "scim_user_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/scim/replace-provisioned-user-information.json b/openapi/api.github.com/operations/scim/replace-provisioned-user-information.json index e932b3ac7d..50b4179792 100644 --- a/openapi/api.github.com/operations/scim/replace-provisioned-user-information.json +++ b/openapi/api.github.com/operations/scim/replace-provisioned-user-information.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "scim_user_id", + "description": "scim_user_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "scim_user_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/scim/update-user-attribute.json b/openapi/api.github.com/operations/scim/update-user-attribute.json index 8b41a75f38..e9e9fd7265 100644 --- a/openapi/api.github.com/operations/scim/update-user-attribute.json +++ b/openapi/api.github.com/operations/scim/update-user-attribute.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "scim_user_id", + "description": "scim_user_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "scim_user_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/code.json b/openapi/api.github.com/operations/search/code.json index 9add006481..60afe97c20 100644 --- a/openapi/api.github.com/operations/search/code.json +++ b/openapi/api.github.com/operations/search/code.json @@ -21,28 +21,30 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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 search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -50,29 +52,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/commits.json b/openapi/api.github.com/operations/search/commits.json index a6adb636c5..57bf9e99bb 100644 --- a/openapi/api.github.com/operations/search/commits.json +++ b/openapi/api.github.com/operations/search/commits.json @@ -22,29 +22,31 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/email-legacy.json b/openapi/api.github.com/operations/search/email-legacy.json index 986ab76ab3..b38efe927b 100644 --- a/openapi/api.github.com/operations/search/email-legacy.json +++ b/openapi/api.github.com/operations/search/email-legacy.json @@ -21,12 +21,12 @@ }, { "name": "email", + "description": "The email address.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The email address." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/issues-and-pull-requests.json b/openapi/api.github.com/operations/search/issues-and-pull-requests.json index 0467b1e70c..937611a028 100644 --- a/openapi/api.github.com/operations/search/issues-and-pull-requests.json +++ b/openapi/api.github.com/operations/search/issues-and-pull-requests.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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/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", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -46,13 +48,13 @@ "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/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,29 +62,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/issues-legacy.json b/openapi/api.github.com/operations/search/issues-legacy.json index d6fcceafb5..ca8de397fe 100644 --- a/openapi/api.github.com/operations/search/issues-legacy.json +++ b/openapi/api.github.com/operations/search/issues-legacy.json @@ -21,43 +21,43 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repository", + "description": "repository parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repository parameter" + } }, { "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", "in": "path", + "required": true, "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", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/labels.json b/openapi/api.github.com/operations/search/labels.json index 9d2f66f94e..0b47a1a49a 100644 --- a/openapi/api.github.com/operations/search/labels.json +++ b/openapi/api.github.com/operations/search/labels.json @@ -21,38 +21,40 @@ }, { "name": "repository_id", + "description": "The id of the repository.", "in": "query", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "The id of the repository." + } }, { "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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/v3/search/#constructing-a-search-query)." + } }, { "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,9 +62,7 @@ "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": { diff --git a/openapi/api.github.com/operations/search/repos-legacy.json b/openapi/api.github.com/operations/search/repos-legacy.json index 30f098929e..f86e1e5f14 100644 --- a/openapi/api.github.com/operations/search/repos-legacy.json +++ b/openapi/api.github.com/operations/search/repos-legacy.json @@ -21,34 +21,36 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "language", + "description": "Filter results by language.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter results by language." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/repos.json b/openapi/api.github.com/operations/search/repos.json index fb6f295963..abbd27de1d 100644 --- a/openapi/api.github.com/operations/search/repos.json +++ b/openapi/api.github.com/operations/search/repos.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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/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", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "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/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/topics.json b/openapi/api.github.com/operations/search/topics.json index 7be7119565..9814b6124c 100644 --- a/openapi/api.github.com/operations/search/topics.json +++ b/openapi/api.github.com/operations/search/topics.json @@ -21,12 +21,12 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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/v3/search/#constructing-a-search-query)." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/users-legacy.json b/openapi/api.github.com/operations/search/users-legacy.json index b0594dfbf4..a52b9e7677 100644 --- a/openapi/api.github.com/operations/search/users-legacy.json +++ b/openapi/api.github.com/operations/search/users-legacy.json @@ -21,25 +21,27 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/search/users.json b/openapi/api.github.com/operations/search/users.json index a0d5079d21..108e2c262d 100644 --- a/openapi/api.github.com/operations/search/users.json +++ b/openapi/api.github.com/operations/search/users.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "repositories", "joined" ] - }, - "required": false, - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/add-member.json b/openapi/api.github.com/operations/teams/add-member.json index 7d7db8bf52..f0bd0a0b42 100644 --- a/openapi/api.github.com/operations/teams/add-member.json +++ b/openapi/api.github.com/operations/teams/add-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/add-or-update-membership.json b/openapi/api.github.com/operations/teams/add-or-update-membership.json index 18dae2f815..678a7c7c44 100644 --- a/openapi/api.github.com/operations/teams/add-or-update-membership.json +++ b/openapi/api.github.com/operations/teams/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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", + "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.", "enum": [ "member", "maintainer" diff --git a/openapi/api.github.com/operations/teams/add-or-update-project.json b/openapi/api.github.com/operations/teams/add-or-update-project.json index ece9bfe4dd..091c3a80fc 100644 --- a/openapi/api.github.com/operations/teams/add-or-update-project.json +++ b/openapi/api.github.com/operations/teams/add-or-update-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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/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", + "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", "enum": [ "read", "write", diff --git a/openapi/api.github.com/operations/teams/add-or-update-repo.json b/openapi/api.github.com/operations/teams/add-or-update-repo.json index ce3437e012..152fe7f8d3 100644 --- a/openapi/api.github.com/operations/teams/add-or-update-repo.json +++ b/openapi/api.github.com/operations/teams/add-or-update-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -75,8 +75,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/api.github.com/operations/teams/check-manages-repo.json b/openapi/api.github.com/operations/teams/check-manages-repo.json index 595e76811c..2b354e953a 100644 --- a/openapi/api.github.com/operations/teams/check-manages-repo.json +++ b/openapi/api.github.com/operations/teams/check-manages-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/create-discussion-comment.json b/openapi/api.github.com/operations/teams/create-discussion-comment.json index 90180bd326..c4d07fb8d5 100644 --- a/openapi/api.github.com/operations/teams/create-discussion-comment.json +++ b/openapi/api.github.com/operations/teams/create-discussion-comment.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -198,8 +198,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/api.github.com/operations/teams/create-discussion.json b/openapi/api.github.com/operations/teams/create-discussion.json index 2e5cde2cf0..2693b204cf 100644 --- a/openapi/api.github.com/operations/teams/create-discussion.json +++ b/openapi/api.github.com/operations/teams/create-discussion.json @@ -22,12 +22,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -204,16 +204,16 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." }, "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", + "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.", "default": false } }, diff --git a/openapi/api.github.com/operations/teams/create-or-update-id-p-group-connections.json b/openapi/api.github.com/operations/teams/create-or-update-id-p-group-connections.json index 26baac4b22..3bdeae7eb8 100644 --- a/openapi/api.github.com/operations/teams/create-or-update-id-p-group-connections.json +++ b/openapi/api.github.com/operations/teams/create-or-update-id-p-group-connections.json @@ -22,12 +22,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -81,22 +81,22 @@ "type": "object", "properties": { "groups": { - "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", "type": "array", + "description": "The IdP groups you want to connect to a GitHub team. When updating, the new `groups` object will replace the original one. You must include any existing groups that you don't want to remove.", "items": { "type": "object", "properties": { "group_id": { - "description": "ID of the IdP group.", - "type": "string" + "type": "string", + "description": "ID of the IdP group." }, "group_name": { - "description": "Name of the IdP group.", - "type": "string" + "type": "string", + "description": "Name of the IdP group." }, "group_description": { - "description": "Description of the IdP group.", - "type": "string" + "type": "string", + "description": "Description of the IdP group." } }, "required": [ diff --git a/openapi/api.github.com/operations/teams/create.json b/openapi/api.github.com/operations/teams/create.json index 55120df190..ecbdf5cbf3 100644 --- a/openapi/api.github.com/operations/teams/create.json +++ b/openapi/api.github.com/operations/teams/create.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -197,38 +197,38 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "maintainers": { - "description": "The logins of organization members to add as maintainers of the team.", "type": "array", + "description": "The logins of organization members to add as maintainers of the team.", "items": { "type": "string" } }, "repo_names": { - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -237,8 +237,8 @@ "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/api.github.com/operations/teams/delete-discussion-comment.json b/openapi/api.github.com/operations/teams/delete-discussion-comment.json index 4fd2f69f46..704ad617b1 100644 --- a/openapi/api.github.com/operations/teams/delete-discussion-comment.json +++ b/openapi/api.github.com/operations/teams/delete-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/delete-discussion.json b/openapi/api.github.com/operations/teams/delete-discussion.json index cff3929252..9d33a7b54b 100644 --- a/openapi/api.github.com/operations/teams/delete-discussion.json +++ b/openapi/api.github.com/operations/teams/delete-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/delete.json b/openapi/api.github.com/operations/teams/delete.json index 88ca95537a..748ec47681 100644 --- a/openapi/api.github.com/operations/teams/delete.json +++ b/openapi/api.github.com/operations/teams/delete.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/get-by-name.json b/openapi/api.github.com/operations/teams/get-by-name.json index 24ac4d71df..264cdae9a8 100644 --- a/openapi/api.github.com/operations/teams/get-by-name.json +++ b/openapi/api.github.com/operations/teams/get-by-name.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "team_slug", + "description": "team_slug parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "team_slug parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/get-discussion-comment.json b/openapi/api.github.com/operations/teams/get-discussion-comment.json index c063e54380..32455e0fca 100644 --- a/openapi/api.github.com/operations/teams/get-discussion-comment.json +++ b/openapi/api.github.com/operations/teams/get-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/get-discussion.json b/openapi/api.github.com/operations/teams/get-discussion.json index 3c2fff17cf..38db8ea9b0 100644 --- a/openapi/api.github.com/operations/teams/get-discussion.json +++ b/openapi/api.github.com/operations/teams/get-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/get-member.json b/openapi/api.github.com/operations/teams/get-member.json index eed5350635..3ee2e602ad 100644 --- a/openapi/api.github.com/operations/teams/get-member.json +++ b/openapi/api.github.com/operations/teams/get-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/get-membership.json b/openapi/api.github.com/operations/teams/get-membership.json index 18200f50c6..e4ebe246fc 100644 --- a/openapi/api.github.com/operations/teams/get-membership.json +++ b/openapi/api.github.com/operations/teams/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/get.json b/openapi/api.github.com/operations/teams/get.json index cd4deb3d68..8441c23383 100644 --- a/openapi/api.github.com/operations/teams/get.json +++ b/openapi/api.github.com/operations/teams/get.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-child.json b/openapi/api.github.com/operations/teams/list-child.json index 8771c93755..524b6716fe 100644 --- a/openapi/api.github.com/operations/teams/list-child.json +++ b/openapi/api.github.com/operations/teams/list-child.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-discussion-comments.json b/openapi/api.github.com/operations/teams/list-discussion-comments.json index e6641577fc..1260240136 100644 --- a/openapi/api.github.com/operations/teams/list-discussion-comments.json +++ b/openapi/api.github.com/operations/teams/list-discussion-comments.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-discussions.json b/openapi/api.github.com/operations/teams/list-discussions.json index f710f630f5..d133f309c1 100644 --- a/openapi/api.github.com/operations/teams/list-discussions.json +++ b/openapi/api.github.com/operations/teams/list-discussions.json @@ -22,16 +22,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-for-authenticated-user.json b/openapi/api.github.com/operations/teams/list-for-authenticated-user.json index 96ca149c4c..f6c45db6d2 100644 --- a/openapi/api.github.com/operations/teams/list-for-authenticated-user.json +++ b/openapi/api.github.com/operations/teams/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-id-p-groups-for-org.json b/openapi/api.github.com/operations/teams/list-id-p-groups-for-org.json index 901b446dda..d349dd14cd 100644 --- a/openapi/api.github.com/operations/teams/list-id-p-groups-for-org.json +++ b/openapi/api.github.com/operations/teams/list-id-p-groups-for-org.json @@ -22,32 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-id-p-groups.json b/openapi/api.github.com/operations/teams/list-id-p-groups.json index 9ca949142f..5de4e33792 100644 --- a/openapi/api.github.com/operations/teams/list-id-p-groups.json +++ b/openapi/api.github.com/operations/teams/list-id-p-groups.json @@ -22,12 +22,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-members.json b/openapi/api.github.com/operations/teams/list-members.json index bc0b43b47b..914f493cc3 100644 --- a/openapi/api.github.com/operations/teams/list-members.json +++ b/openapi/api.github.com/operations/teams/list-members.json @@ -21,16 +21,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-pending-invitations.json b/openapi/api.github.com/operations/teams/list-pending-invitations.json index cab6cd610b..9b9a4e8a8a 100644 --- a/openapi/api.github.com/operations/teams/list-pending-invitations.json +++ b/openapi/api.github.com/operations/teams/list-pending-invitations.json @@ -21,32 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-projects.json b/openapi/api.github.com/operations/teams/list-projects.json index 0c9b228cf7..5fe8bf53f2 100644 --- a/openapi/api.github.com/operations/teams/list-projects.json +++ b/openapi/api.github.com/operations/teams/list-projects.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list-repos.json b/openapi/api.github.com/operations/teams/list-repos.json index 836c125e8b..62df3bd7bf 100644 --- a/openapi/api.github.com/operations/teams/list-repos.json +++ b/openapi/api.github.com/operations/teams/list-repos.json @@ -21,32 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/list.json b/openapi/api.github.com/operations/teams/list.json index 4d66aaffbc..616b1001dc 100644 --- a/openapi/api.github.com/operations/teams/list.json +++ b/openapi/api.github.com/operations/teams/list.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/remove-member.json b/openapi/api.github.com/operations/teams/remove-member.json index 7641b11503..0478abd5d1 100644 --- a/openapi/api.github.com/operations/teams/remove-member.json +++ b/openapi/api.github.com/operations/teams/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/remove-membership.json b/openapi/api.github.com/operations/teams/remove-membership.json index 2b569e1322..f8319c5826 100644 --- a/openapi/api.github.com/operations/teams/remove-membership.json +++ b/openapi/api.github.com/operations/teams/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/remove-project.json b/openapi/api.github.com/operations/teams/remove-project.json index e9c79875d8..e8da6d0175 100644 --- a/openapi/api.github.com/operations/teams/remove-project.json +++ b/openapi/api.github.com/operations/teams/remove-project.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/remove-repo.json b/openapi/api.github.com/operations/teams/remove-repo.json index 361c722e7a..623d9d63c4 100644 --- a/openapi/api.github.com/operations/teams/remove-repo.json +++ b/openapi/api.github.com/operations/teams/remove-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/review-project.json b/openapi/api.github.com/operations/teams/review-project.json index ee9059daee..c937ec0133 100644 --- a/openapi/api.github.com/operations/teams/review-project.json +++ b/openapi/api.github.com/operations/teams/review-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/teams/update-discussion-comment.json b/openapi/api.github.com/operations/teams/update-discussion-comment.json index 1e9f82f942..60b4aeb7b2 100644 --- a/openapi/api.github.com/operations/teams/update-discussion-comment.json +++ b/openapi/api.github.com/operations/teams/update-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -206,8 +206,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/api.github.com/operations/teams/update-discussion.json b/openapi/api.github.com/operations/teams/update-discussion.json index 529882941d..4e0a32535f 100644 --- a/openapi/api.github.com/operations/teams/update-discussion.json +++ b/openapi/api.github.com/operations/teams/update-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -212,12 +212,12 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." } } } diff --git a/openapi/api.github.com/operations/teams/update.json b/openapi/api.github.com/operations/teams/update.json index 31b9bfaf4c..36b6a7b3b4 100644 --- a/openapi/api.github.com/operations/teams/update.json +++ b/openapi/api.github.com/operations/teams/update.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -197,24 +197,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -223,8 +223,8 @@ "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/api.github.com/operations/users/add-emails.json b/openapi/api.github.com/operations/users/add-emails.json index 92d0d2f576..c8cf9e6c9a 100644 --- a/openapi/api.github.com/operations/users/add-emails.json +++ b/openapi/api.github.com/operations/users/add-emails.json @@ -72,8 +72,8 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/users/block.json b/openapi/api.github.com/operations/users/block.json index 9d5da9b796..8e4193bd86 100644 --- a/openapi/api.github.com/operations/users/block.json +++ b/openapi/api.github.com/operations/users/block.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/check-blocked.json b/openapi/api.github.com/operations/users/check-blocked.json index 6545e6761e..a00b161c85 100644 --- a/openapi/api.github.com/operations/users/check-blocked.json +++ b/openapi/api.github.com/operations/users/check-blocked.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/check-following-for-user.json b/openapi/api.github.com/operations/users/check-following-for-user.json index 35889ea1ae..6c1b8eebb4 100644 --- a/openapi/api.github.com/operations/users/check-following-for-user.json +++ b/openapi/api.github.com/operations/users/check-following-for-user.json @@ -21,21 +21,21 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "target_user", + "description": "target_user parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "target_user parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/check-following.json b/openapi/api.github.com/operations/users/check-following.json index 92d53dc38f..2f2e8acb6d 100644 --- a/openapi/api.github.com/operations/users/check-following.json +++ b/openapi/api.github.com/operations/users/check-following.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/create-gpg-key.json b/openapi/api.github.com/operations/users/create-gpg-key.json index ca1b40af16..993a9b70a3 100644 --- a/openapi/api.github.com/operations/users/create-gpg-key.json +++ b/openapi/api.github.com/operations/users/create-gpg-key.json @@ -147,8 +147,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/api.github.com/operations/users/create-public-key.json b/openapi/api.github.com/operations/users/create-public-key.json index 11d3e39868..2745d34d28 100644 --- a/openapi/api.github.com/operations/users/create-public-key.json +++ b/openapi/api.github.com/operations/users/create-public-key.json @@ -78,12 +78,12 @@ "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/api.github.com/operations/users/delete-emails.json b/openapi/api.github.com/operations/users/delete-emails.json index 84b6d30c0c..d90b90f0a0 100644 --- a/openapi/api.github.com/operations/users/delete-emails.json +++ b/openapi/api.github.com/operations/users/delete-emails.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "emails": { - "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/api.github.com/operations/users/delete-gpg-key.json b/openapi/api.github.com/operations/users/delete-gpg-key.json index 3e7d0b5c72..504ee18395 100644 --- a/openapi/api.github.com/operations/users/delete-gpg-key.json +++ b/openapi/api.github.com/operations/users/delete-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/delete-public-key.json b/openapi/api.github.com/operations/users/delete-public-key.json index d2f10aa48c..2b31b2d278 100644 --- a/openapi/api.github.com/operations/users/delete-public-key.json +++ b/openapi/api.github.com/operations/users/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/follow.json b/openapi/api.github.com/operations/users/follow.json index 577bf9e785..3480783b6e 100644 --- a/openapi/api.github.com/operations/users/follow.json +++ b/openapi/api.github.com/operations/users/follow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/get-by-username.json b/openapi/api.github.com/operations/users/get-by-username.json index fde80c8a80..936b2eb6dc 100644 --- a/openapi/api.github.com/operations/users/get-by-username.json +++ b/openapi/api.github.com/operations/users/get-by-username.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/get-context-for-user.json b/openapi/api.github.com/operations/users/get-context-for-user.json index a7466536be..11faf92644 100644 --- a/openapi/api.github.com/operations/users/get-context-for-user.json +++ b/openapi/api.github.com/operations/users/get-context-for-user.json @@ -22,16 +22,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "subject_type", + "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`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,18 +42,16 @@ "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", + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/get-gpg-key.json b/openapi/api.github.com/operations/users/get-gpg-key.json index 5ebc6c71ac..d9ad4b0228 100644 --- a/openapi/api.github.com/operations/users/get-gpg-key.json +++ b/openapi/api.github.com/operations/users/get-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/get-public-key.json b/openapi/api.github.com/operations/users/get-public-key.json index 4b87e779a7..7acda1778d 100644 --- a/openapi/api.github.com/operations/users/get-public-key.json +++ b/openapi/api.github.com/operations/users/get-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-emails.json b/openapi/api.github.com/operations/users/list-emails.json index 50dfd788b0..587e1801dc 100644 --- a/openapi/api.github.com/operations/users/list-emails.json +++ b/openapi/api.github.com/operations/users/list-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-followers-for-authenticated-user.json b/openapi/api.github.com/operations/users/list-followers-for-authenticated-user.json index 002a2c67a3..2a6a7c03f9 100644 --- a/openapi/api.github.com/operations/users/list-followers-for-authenticated-user.json +++ b/openapi/api.github.com/operations/users/list-followers-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-followers-for-user.json b/openapi/api.github.com/operations/users/list-followers-for-user.json index 5c5eb282a3..c22bece10d 100644 --- a/openapi/api.github.com/operations/users/list-followers-for-user.json +++ b/openapi/api.github.com/operations/users/list-followers-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-following-for-authenticated-user.json b/openapi/api.github.com/operations/users/list-following-for-authenticated-user.json index 614e9ed149..bec70fef28 100644 --- a/openapi/api.github.com/operations/users/list-following-for-authenticated-user.json +++ b/openapi/api.github.com/operations/users/list-following-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-following-for-user.json b/openapi/api.github.com/operations/users/list-following-for-user.json index cd6e529875..a543060c7b 100644 --- a/openapi/api.github.com/operations/users/list-following-for-user.json +++ b/openapi/api.github.com/operations/users/list-following-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-gpg-keys-for-user.json b/openapi/api.github.com/operations/users/list-gpg-keys-for-user.json index 856cb753ef..3f346cf27e 100644 --- a/openapi/api.github.com/operations/users/list-gpg-keys-for-user.json +++ b/openapi/api.github.com/operations/users/list-gpg-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-gpg-keys.json b/openapi/api.github.com/operations/users/list-gpg-keys.json index f0fd8a4681..8eee60a280 100644 --- a/openapi/api.github.com/operations/users/list-gpg-keys.json +++ b/openapi/api.github.com/operations/users/list-gpg-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-public-emails.json b/openapi/api.github.com/operations/users/list-public-emails.json index 829e8e199d..0e1b7d42ff 100644 --- a/openapi/api.github.com/operations/users/list-public-emails.json +++ b/openapi/api.github.com/operations/users/list-public-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-public-keys-for-user.json b/openapi/api.github.com/operations/users/list-public-keys-for-user.json index a48b3457b3..b9df0c0db5 100644 --- a/openapi/api.github.com/operations/users/list-public-keys-for-user.json +++ b/openapi/api.github.com/operations/users/list-public-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list-public-keys.json b/openapi/api.github.com/operations/users/list-public-keys.json index 0f323bc1b6..0c65051e1d 100644 --- a/openapi/api.github.com/operations/users/list-public-keys.json +++ b/openapi/api.github.com/operations/users/list-public-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/list.json b/openapi/api.github.com/operations/users/list.json index dc1b5e922d..1c2bb9b230 100644 --- a/openapi/api.github.com/operations/users/list.json +++ b/openapi/api.github.com/operations/users/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last User that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last User that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/toggle-primary-email-visibility.json b/openapi/api.github.com/operations/users/toggle-primary-email-visibility.json index 84e603d7ec..bf1035854f 100644 --- a/openapi/api.github.com/operations/users/toggle-primary-email-visibility.json +++ b/openapi/api.github.com/operations/users/toggle-primary-email-visibility.json @@ -72,12 +72,12 @@ "type": "object", "properties": { "email": { - "description": "Specify the _primary_ email address that needs a visibility change.", - "type": "string" + "type": "string", + "description": "Specify the _primary_ email address that needs a visibility change." }, "visibility": { - "description": "Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly.", - "type": "string" + "type": "string", + "description": "Use `public` to enable an authenticated user to view the specified email address, or use `private` so this primary email address cannot be seen publicly." } }, "required": [ diff --git a/openapi/api.github.com/operations/users/unblock.json b/openapi/api.github.com/operations/users/unblock.json index c44f8d31a7..f57ed521a6 100644 --- a/openapi/api.github.com/operations/users/unblock.json +++ b/openapi/api.github.com/operations/users/unblock.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/unfollow.json b/openapi/api.github.com/operations/users/unfollow.json index 80e4463b43..13f15977ee 100644 --- a/openapi/api.github.com/operations/users/unfollow.json +++ b/openapi/api.github.com/operations/users/unfollow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/api.github.com/operations/users/update-authenticated.json b/openapi/api.github.com/operations/users/update-authenticated.json index 1baf342c1b..ec0c96258c 100644 --- a/openapi/api.github.com/operations/users/update-authenticated.json +++ b/openapi/api.github.com/operations/users/update-authenticated.json @@ -185,32 +185,32 @@ "type": "object", "properties": { "name": { - "description": "The new name of the user.", - "type": "string" + "type": "string", + "description": "The new name of the user." }, "email": { - "description": "The publicly visible email address of the user.", - "type": "string" + "type": "string", + "description": "The publicly visible email address of the user." }, "blog": { - "description": "The new blog URL of the user.", - "type": "string" + "type": "string", + "description": "The new blog URL of the user." }, "company": { - "description": "The new company of the user.", - "type": "string" + "type": "string", + "description": "The new company of the user." }, "location": { - "description": "The new location of the user.", - "type": "string" + "type": "string", + "description": "The new location of the user." }, "hireable": { - "description": "The new hiring availability of the user.", - "type": "boolean" + "type": "boolean", + "description": "The new hiring availability of the user." }, "bio": { - "description": "The new short biography of the user.", - "type": "string" + "type": "string", + "description": "The new short biography of the user." } } } diff --git a/openapi/ghe-2.15/operations/activity/check-starring-repo.json b/openapi/ghe-2.15/operations/activity/check-starring-repo.json index b52ab6b2e3..48bb564053 100644 --- a/openapi/ghe-2.15/operations/activity/check-starring-repo.json +++ b/openapi/ghe-2.15/operations/activity/check-starring-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/check-watching-repo-legacy.json b/openapi/ghe-2.15/operations/activity/check-watching-repo-legacy.json index cb2441125f..1256279434 100644 --- a/openapi/ghe-2.15/operations/activity/check-watching-repo-legacy.json +++ b/openapi/ghe-2.15/operations/activity/check-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/delete-repo-subscription.json b/openapi/ghe-2.15/operations/activity/delete-repo-subscription.json index fe0812a897..dbb293a772 100644 --- a/openapi/ghe-2.15/operations/activity/delete-repo-subscription.json +++ b/openapi/ghe-2.15/operations/activity/delete-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/delete-thread-subscription.json b/openapi/ghe-2.15/operations/activity/delete-thread-subscription.json index 82aea6fccd..ddd28e2a33 100644 --- a/openapi/ghe-2.15/operations/activity/delete-thread-subscription.json +++ b/openapi/ghe-2.15/operations/activity/delete-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/get-repo-subscription.json b/openapi/ghe-2.15/operations/activity/get-repo-subscription.json index ef2a829ec1..feed347cda 100644 --- a/openapi/ghe-2.15/operations/activity/get-repo-subscription.json +++ b/openapi/ghe-2.15/operations/activity/get-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/get-thread-subscription.json b/openapi/ghe-2.15/operations/activity/get-thread-subscription.json index 7fc6bc6fa9..8417c3cd6a 100644 --- a/openapi/ghe-2.15/operations/activity/get-thread-subscription.json +++ b/openapi/ghe-2.15/operations/activity/get-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/get-thread.json b/openapi/ghe-2.15/operations/activity/get-thread.json index 7fce28571b..e02c7197a9 100644 --- a/openapi/ghe-2.15/operations/activity/get-thread.json +++ b/openapi/ghe-2.15/operations/activity/get-thread.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-events-for-org.json b/openapi/ghe-2.15/operations/activity/list-events-for-org.json index 8a532a1bc2..302313bf25 100644 --- a/openapi/ghe-2.15/operations/activity/list-events-for-org.json +++ b/openapi/ghe-2.15/operations/activity/list-events-for-org.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-events-for-user.json b/openapi/ghe-2.15/operations/activity/list-events-for-user.json index 7c907785d8..fe63a7255e 100644 --- a/openapi/ghe-2.15/operations/activity/list-events-for-user.json +++ b/openapi/ghe-2.15/operations/activity/list-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-notifications-for-repo.json b/openapi/ghe-2.15/operations/activity/list-notifications-for-repo.json index 7b5992e8d0..aa5f329152 100644 --- a/openapi/ghe-2.15/operations/activity/list-notifications-for-repo.json +++ b/openapi/ghe-2.15/operations/activity/list-notifications-for-repo.json @@ -21,79 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-notifications.json b/openapi/ghe-2.15/operations/activity/list-notifications.json index 6128c34016..f271355618 100644 --- a/openapi/ghe-2.15/operations/activity/list-notifications.json +++ b/openapi/ghe-2.15/operations/activity/list-notifications.json @@ -21,61 +21,59 @@ }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-public-events-for-org.json b/openapi/ghe-2.15/operations/activity/list-public-events-for-org.json index 9b6024db30..7fe999e209 100644 --- a/openapi/ghe-2.15/operations/activity/list-public-events-for-org.json +++ b/openapi/ghe-2.15/operations/activity/list-public-events-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-public-events-for-repo-network.json b/openapi/ghe-2.15/operations/activity/list-public-events-for-repo-network.json index c6c5ca8665..0866e37b00 100644 --- a/openapi/ghe-2.15/operations/activity/list-public-events-for-repo-network.json +++ b/openapi/ghe-2.15/operations/activity/list-public-events-for-repo-network.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-public-events-for-user.json b/openapi/ghe-2.15/operations/activity/list-public-events-for-user.json index 4660785b56..7142c1da5f 100644 --- a/openapi/ghe-2.15/operations/activity/list-public-events-for-user.json +++ b/openapi/ghe-2.15/operations/activity/list-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-public-events.json b/openapi/ghe-2.15/operations/activity/list-public-events.json index 926bec7c61..2745d698da 100644 --- a/openapi/ghe-2.15/operations/activity/list-public-events.json +++ b/openapi/ghe-2.15/operations/activity/list-public-events.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-received-events-for-user.json b/openapi/ghe-2.15/operations/activity/list-received-events-for-user.json index 7fae472312..6ff83aca0e 100644 --- a/openapi/ghe-2.15/operations/activity/list-received-events-for-user.json +++ b/openapi/ghe-2.15/operations/activity/list-received-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-received-public-events-for-user.json b/openapi/ghe-2.15/operations/activity/list-received-public-events-for-user.json index e14b6a3da5..d9698e6705 100644 --- a/openapi/ghe-2.15/operations/activity/list-received-public-events-for-user.json +++ b/openapi/ghe-2.15/operations/activity/list-received-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-repo-events.json b/openapi/ghe-2.15/operations/activity/list-repo-events.json index e4666c867d..8ff70d47fd 100644 --- a/openapi/ghe-2.15/operations/activity/list-repo-events.json +++ b/openapi/ghe-2.15/operations/activity/list-repo-events.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-repos-starred-by-authenticated-user.json b/openapi/ghe-2.15/operations/activity/list-repos-starred-by-authenticated-user.json index 75983fd586..0d40b90cea 100644 --- a/openapi/ghe-2.15/operations/activity/list-repos-starred-by-authenticated-user.json +++ b/openapi/ghe-2.15/operations/activity/list-repos-starred-by-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -29,13 +31,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -43,29 +45,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-repos-starred-by-user.json b/openapi/ghe-2.15/operations/activity/list-repos-starred-by-user.json index 0a6506a6f8..f06ac8a527 100644 --- a/openapi/ghe-2.15/operations/activity/list-repos-starred-by-user.json +++ b/openapi/ghe-2.15/operations/activity/list-repos-starred-by-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-repos-watched-by-user.json b/openapi/ghe-2.15/operations/activity/list-repos-watched-by-user.json index eb5355d059..b36db9ee07 100644 --- a/openapi/ghe-2.15/operations/activity/list-repos-watched-by-user.json +++ b/openapi/ghe-2.15/operations/activity/list-repos-watched-by-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-stargazers-for-repo.json b/openapi/ghe-2.15/operations/activity/list-stargazers-for-repo.json index 2d33c3b67b..2812c4469b 100644 --- a/openapi/ghe-2.15/operations/activity/list-stargazers-for-repo.json +++ b/openapi/ghe-2.15/operations/activity/list-stargazers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-watched-repos-for-authenticated-user.json b/openapi/ghe-2.15/operations/activity/list-watched-repos-for-authenticated-user.json index 06f2a584d8..e0176b5e4c 100644 --- a/openapi/ghe-2.15/operations/activity/list-watched-repos-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/activity/list-watched-repos-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/list-watchers-for-repo.json b/openapi/ghe-2.15/operations/activity/list-watchers-for-repo.json index e7380f63c2..50a21eb48c 100644 --- a/openapi/ghe-2.15/operations/activity/list-watchers-for-repo.json +++ b/openapi/ghe-2.15/operations/activity/list-watchers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/mark-as-read.json b/openapi/ghe-2.15/operations/activity/mark-as-read.json index f53489fd6f..ad4231198f 100644 --- a/openapi/ghe-2.15/operations/activity/mark-as-read.json +++ b/openapi/ghe-2.15/operations/activity/mark-as-read.json @@ -48,8 +48,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/ghe-2.15/operations/activity/mark-notifications-as-read-for-repo.json b/openapi/ghe-2.15/operations/activity/mark-notifications-as-read-for-repo.json index b0b2713918..8412c6b50e 100644 --- a/openapi/ghe-2.15/operations/activity/mark-notifications-as-read-for-repo.json +++ b/openapi/ghe-2.15/operations/activity/mark-notifications-as-read-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/ghe-2.15/operations/activity/mark-thread-as-read.json b/openapi/ghe-2.15/operations/activity/mark-thread-as-read.json index 3b0a896c39..3845cb72c0 100644 --- a/openapi/ghe-2.15/operations/activity/mark-thread-as-read.json +++ b/openapi/ghe-2.15/operations/activity/mark-thread-as-read.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/set-repo-subscription.json b/openapi/ghe-2.15/operations/activity/set-repo-subscription.json index f4fc85bb2f..3527bf0374 100644 --- a/openapi/ghe-2.15/operations/activity/set-repo-subscription.json +++ b/openapi/ghe-2.15/operations/activity/set-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -93,12 +93,12 @@ "type": "object", "properties": { "subscribed": { - "description": "Determines if notifications should be received from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if notifications should be received from this repository." }, "ignored": { - "description": "Determines if all notifications should be blocked from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if all notifications should be blocked from this repository." } } } diff --git a/openapi/ghe-2.15/operations/activity/set-thread-subscription.json b/openapi/ghe-2.15/operations/activity/set-thread-subscription.json index 81a6c36203..8a5ef80828 100644 --- a/openapi/ghe-2.15/operations/activity/set-thread-subscription.json +++ b/openapi/ghe-2.15/operations/activity/set-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { @@ -84,8 +84,8 @@ "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", + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", "default": false } } diff --git a/openapi/ghe-2.15/operations/activity/star-repo.json b/openapi/ghe-2.15/operations/activity/star-repo.json index b5c164beb3..a9efc03da4 100644 --- a/openapi/ghe-2.15/operations/activity/star-repo.json +++ b/openapi/ghe-2.15/operations/activity/star-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/stop-watching-repo-legacy.json b/openapi/ghe-2.15/operations/activity/stop-watching-repo-legacy.json index 4d1db837b4..076e63acf9 100644 --- a/openapi/ghe-2.15/operations/activity/stop-watching-repo-legacy.json +++ b/openapi/ghe-2.15/operations/activity/stop-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/unstar-repo.json b/openapi/ghe-2.15/operations/activity/unstar-repo.json index 21e8ab906f..e8e3d3d54d 100644 --- a/openapi/ghe-2.15/operations/activity/unstar-repo.json +++ b/openapi/ghe-2.15/operations/activity/unstar-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/activity/watch-repo-legacy.json b/openapi/ghe-2.15/operations/activity/watch-repo-legacy.json index b8477d2372..6184772d0b 100644 --- a/openapi/ghe-2.15/operations/activity/watch-repo-legacy.json +++ b/openapi/ghe-2.15/operations/activity/watch-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/add-repo-to-installation.json b/openapi/ghe-2.15/operations/apps/add-repo-to-installation.json index 0ab052fec9..be14980fb8 100644 --- a/openapi/ghe-2.15/operations/apps/add-repo-to-installation.json +++ b/openapi/ghe-2.15/operations/apps/add-repo-to-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/create-installation-token.json b/openapi/ghe-2.15/operations/apps/create-installation-token.json index 6be169bfbe..84783ec758 100644 --- a/openapi/ghe-2.15/operations/apps/create-installation-token.json +++ b/openapi/ghe-2.15/operations/apps/create-installation-token.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/get-by-slug.json b/openapi/ghe-2.15/operations/apps/get-by-slug.json index 41ba58251d..736fd16ea3 100644 --- a/openapi/ghe-2.15/operations/apps/get-by-slug.json +++ b/openapi/ghe-2.15/operations/apps/get-by-slug.json @@ -22,12 +22,12 @@ }, { "name": "app_slug", + "description": "app_slug parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "app_slug parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/get-installation.json b/openapi/ghe-2.15/operations/apps/get-installation.json index 21475276d1..d9d2a33737 100644 --- a/openapi/ghe-2.15/operations/apps/get-installation.json +++ b/openapi/ghe-2.15/operations/apps/get-installation.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/get-org-installation.json b/openapi/ghe-2.15/operations/apps/get-org-installation.json index dfcab507bb..d363ce3329 100644 --- a/openapi/ghe-2.15/operations/apps/get-org-installation.json +++ b/openapi/ghe-2.15/operations/apps/get-org-installation.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/get-repo-installation.json b/openapi/ghe-2.15/operations/apps/get-repo-installation.json index 9fef345465..f09b758f35 100644 --- a/openapi/ghe-2.15/operations/apps/get-repo-installation.json +++ b/openapi/ghe-2.15/operations/apps/get-repo-installation.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/get-user-installation.json b/openapi/ghe-2.15/operations/apps/get-user-installation.json index 5a9b3c448f..ba786204e1 100644 --- a/openapi/ghe-2.15/operations/apps/get-user-installation.json +++ b/openapi/ghe-2.15/operations/apps/get-user-installation.json @@ -22,12 +22,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/list-installation-repos-for-authenticated-user.json b/openapi/ghe-2.15/operations/apps/list-installation-repos-for-authenticated-user.json index 01203153e6..88efbab3ae 100644 --- a/openapi/ghe-2.15/operations/apps/list-installation-repos-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/apps/list-installation-repos-for-authenticated-user.json @@ -22,32 +22,30 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/list-installations-for-authenticated-user.json b/openapi/ghe-2.15/operations/apps/list-installations-for-authenticated-user.json index b245510340..4f1a796c8a 100644 --- a/openapi/ghe-2.15/operations/apps/list-installations-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/apps/list-installations-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/list-installations.json b/openapi/ghe-2.15/operations/apps/list-installations.json index 3cb6602bb9..10435ebb0b 100644 --- a/openapi/ghe-2.15/operations/apps/list-installations.json +++ b/openapi/ghe-2.15/operations/apps/list-installations.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/list-repos.json b/openapi/ghe-2.15/operations/apps/list-repos.json index 9044f7977f..d9d31971f2 100644 --- a/openapi/ghe-2.15/operations/apps/list-repos.json +++ b/openapi/ghe-2.15/operations/apps/list-repos.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/apps/remove-repo-from-installation.json b/openapi/ghe-2.15/operations/apps/remove-repo-from-installation.json index 307c7ddc3b..0fd60cd5bc 100644 --- a/openapi/ghe-2.15/operations/apps/remove-repo-from-installation.json +++ b/openapi/ghe-2.15/operations/apps/remove-repo-from-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/create-suite.json b/openapi/ghe-2.15/operations/checks/create-suite.json index 67fd18063a..5bc3d499bd 100644 --- a/openapi/ghe-2.15/operations/checks/create-suite.json +++ b/openapi/ghe-2.15/operations/checks/create-suite.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -480,8 +480,8 @@ "type": "object", "properties": { "head_sha": { - "description": "The sha of the head commit.", - "type": "string" + "type": "string", + "description": "The sha of the head commit." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/checks/create.json b/openapi/ghe-2.15/operations/checks/create.json index d3a9b2589a..1fd960abb7 100644 --- a/openapi/ghe-2.15/operations/checks/create.json +++ b/openapi/ghe-2.15/operations/checks/create.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -271,24 +271,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "head_sha": { - "description": "The SHA of the commit.", - "type": "string" + "type": "string", + "description": "The SHA of the commit." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -297,12 +297,12 @@ "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" + "type": "string", + "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`." }, "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", + "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`.", "enum": [ "success", "failure", @@ -313,54 +313,54 @@ ] }, "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" + "type": "string", + "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`." }, "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.15/v3/checks/runs/#output-object) description.", "type": "object", + "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.15/v3/checks/runs/#output-object) description.", "properties": { "title": { - "description": "The title of the check run.", - "type": "string" + "type": "string", + "description": "The title of the check run." }, "summary": { - "description": "The summary of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The summary of the check run. This parameter supports Markdown." }, "text": { - "description": "The details of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The details of the check run. This parameter supports Markdown." }, "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.15/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.15/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "type": "array", + "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.15/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.15/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -368,16 +368,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -390,22 +390,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.15/v3/checks/runs/#images-object) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.15/v3/checks/runs/#images-object) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -421,22 +421,22 @@ ] }, "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.15/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.15/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.15/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.15/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "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.15/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.15/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.15/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.15/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/checks/get-suite.json b/openapi/ghe-2.15/operations/checks/get-suite.json index dffb495906..054879bed6 100644 --- a/openapi/ghe-2.15/operations/checks/get-suite.json +++ b/openapi/ghe-2.15/operations/checks/get-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/get.json b/openapi/ghe-2.15/operations/checks/get.json index d07c38cd3b..461a871024 100644 --- a/openapi/ghe-2.15/operations/checks/get.json +++ b/openapi/ghe-2.15/operations/checks/get.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/list-annotations.json b/openapi/ghe-2.15/operations/checks/list-annotations.json index 3e3929dfa9..47b22959e7 100644 --- a/openapi/ghe-2.15/operations/checks/list-annotations.json +++ b/openapi/ghe-2.15/operations/checks/list-annotations.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/list-for-ref.json b/openapi/ghe-2.15/operations/checks/list-for-ref.json index f4232b6021..6cd020ba11 100644 --- a/openapi/ghe-2.15/operations/checks/list-for-ref.json +++ b/openapi/ghe-2.15/operations/checks/list-for-ref.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/list-for-suite.json b/openapi/ghe-2.15/operations/checks/list-for-suite.json index 701e3e4a30..fe705fc37c 100644 --- a/openapi/ghe-2.15/operations/checks/list-for-suite.json +++ b/openapi/ghe-2.15/operations/checks/list-for-suite.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/list-suites-for-ref.json b/openapi/ghe-2.15/operations/checks/list-suites-for-ref.json index b997092b36..7aebda1dbf 100644 --- a/openapi/ghe-2.15/operations/checks/list-suites-for-ref.json +++ b/openapi/ghe-2.15/operations/checks/list-suites-for-ref.json @@ -22,68 +22,66 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", "in": "query", + "required": false, "schema": { "type": "integer" - }, - "required": false, - "description": "Filters check suites by GitHub App `id`." + } }, { "name": "check_name", + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.15/v3/checks/runs/).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.15/v3/checks/runs/)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/rerequest-suite.json b/openapi/ghe-2.15/operations/checks/rerequest-suite.json index 3b1e495f36..70fefc1f17 100644 --- a/openapi/ghe-2.15/operations/checks/rerequest-suite.json +++ b/openapi/ghe-2.15/operations/checks/rerequest-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/checks/set-suites-preferences.json b/openapi/ghe-2.15/operations/checks/set-suites-preferences.json index d014a67161..85b264e4bf 100644 --- a/openapi/ghe-2.15/operations/checks/set-suites-preferences.json +++ b/openapi/ghe-2.15/operations/checks/set-suites-preferences.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -402,18 +402,18 @@ "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.15/v3/checks/suites/#auto_trigger_checks-object) description for details.", "type": "array", + "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.15/v3/checks/suites/#auto_trigger_checks-object) description for details.", "items": { "type": "object", "properties": { "app_id": { - "description": "The `id` of the GitHub App.", - "type": "integer" + "type": "integer", + "description": "The `id` of the GitHub App." }, "setting": { - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "type": "boolean", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/checks/update.json b/openapi/ghe-2.15/operations/checks/update.json index 41e1c2c167..cc63f17dfd 100644 --- a/openapi/ghe-2.15/operations/checks/update.json +++ b/openapi/ghe-2.15/operations/checks/update.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { @@ -286,24 +286,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "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" + "type": "string", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -311,8 +311,8 @@ ] }, "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", + "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`.", "enum": [ "success", "failure", @@ -323,54 +323,54 @@ ] }, "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" + "type": "string", + "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`." }, "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.15/v3/checks/runs/#output-object-1) description.", "type": "object", + "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.15/v3/checks/runs/#output-object-1) description.", "properties": { "title": { - "description": "**Required**.", - "type": "string" + "type": "string", + "description": "**Required**." }, "summary": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "text": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "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.15/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.15/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "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.15/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.15/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -378,16 +378,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -400,22 +400,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.15/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.15/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -430,22 +430,22 @@ ] }, "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.15/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.15/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "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.15/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.15/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/codes-of-conduct/get-conduct-code.json b/openapi/ghe-2.15/operations/codes-of-conduct/get-conduct-code.json index b44050ba3e..3c7a0601c4 100644 --- a/openapi/ghe-2.15/operations/codes-of-conduct/get-conduct-code.json +++ b/openapi/ghe-2.15/operations/codes-of-conduct/get-conduct-code.json @@ -22,12 +22,12 @@ }, { "name": "key", + "description": "key parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/codes-of-conduct/get-for-repo.json b/openapi/ghe-2.15/operations/codes-of-conduct/get-for-repo.json index f515fe7a92..e37b32bdb9 100644 --- a/openapi/ghe-2.15/operations/codes-of-conduct/get-for-repo.json +++ b/openapi/ghe-2.15/operations/codes-of-conduct/get-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/add-authorized-ssh-key.json b/openapi/ghe-2.15/operations/enterprise-admin/add-authorized-ssh-key.json index 8c4639fbb1..5ffc7e3d2f 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/add-authorized-ssh-key.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/add-authorized-ssh-key.json @@ -66,8 +66,8 @@ "type": "object", "properties": { "authorized_key": { - "description": "The path to the public SSH key.", - "type": "string" + "type": "string", + "description": "The path to the public SSH key." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/create-global-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/create-global-hook.json index 28f917f3d8..1c761edb3b 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/create-global-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/create-global-hook.json @@ -105,28 +105,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.15/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.15/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -134,15 +134,15 @@ ] }, "events": { - "description": "The [events](https://developer.github.com/enterprise/2.15/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", + "description": "The [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/enterprise-admin/create-impersonation-o-auth-token.json b/openapi/ghe-2.15/operations/enterprise-admin/create-impersonation-o-auth-token.json index 0ab282489f..94d8cd36ff 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/create-impersonation-o-auth-token.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/create-impersonation-o-auth-token.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -116,8 +116,8 @@ "type": "object", "properties": { "scopes": { - "description": "A list of [scopes](https://developer.github.com/enterprise/2.15/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "type": "array", + "description": "A list of [scopes](https://developer.github.com/enterprise/2.15/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/create-org.json b/openapi/ghe-2.15/operations/enterprise-admin/create-org.json index 3a5e4bf057..72a14a351e 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/create-org.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/create-org.json @@ -93,16 +93,16 @@ "type": "object", "properties": { "login": { - "description": "The organization's username.", - "type": "string" + "type": "string", + "description": "The organization's username." }, "admin": { - "description": "The login of the user who will manage this organization.", - "type": "string" + "type": "string", + "description": "The login of the user who will manage this organization." }, "profile_name": { - "description": "The organization's display name.", - "type": "string" + "type": "string", + "description": "The organization's display name." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-environment.json b/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-environment.json index 251725a05e..c33f52fe5a 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-environment.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-environment.json @@ -98,12 +98,12 @@ "type": "object", "properties": { "name": { - "description": "The new pre-receive environment's name.", - "type": "string" + "type": "string", + "description": "The new pre-receive environment's name." }, "image_url": { - "description": "URL from which to download a tarball of this environment.", - "type": "string" + "type": "string", + "description": "URL from which to download a tarball of this environment." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-hook.json index 8522920ccc..dc6d71fcf3 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/create-pre-receive-hook.json @@ -135,30 +135,30 @@ "type": "object", "properties": { "name": { - "description": "The name of the hook.", - "type": "string" + "type": "string", + "description": "The name of the hook." }, "script": { - "description": "The script that the hook runs.", - "type": "string" + "type": "string", + "description": "The script that the hook runs." }, "script_repository": { - "description": "The GitHub repository where the script is kept.", "type": "object", + "description": "The GitHub repository where the script is kept.", "properties": {} }, "environment": { - "description": "The pre-receive environment where the script is executed.", "type": "object", + "description": "The pre-receive environment where the script is executed.", "properties": {} }, "enforcement": { - "description": "The state of enforcement for this hook. default: `disabled`", - "type": "string" + "type": "string", + "description": "The state of enforcement for this hook. default: `disabled`" }, "allow_downstream_configuration": { - "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "type": "boolean" + "type": "boolean", + "description": "Whether enforcement can be overridden at the org or repo level. default: `false`" } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/create-user.json b/openapi/ghe-2.15/operations/enterprise-admin/create-user.json index 8b171a1e71..4ef29e3cef 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/create-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/create-user.json @@ -111,12 +111,12 @@ "type": "object", "properties": { "login": { - "description": "The user's username.", - "type": "string" + "type": "string", + "description": "The user's username." }, "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.15/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", - "type": "string" + "type": "string", + "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.15/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/delete-global-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/delete-global-hook.json index 5609ec3a5e..23da306cb8 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/delete-global-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/delete-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/delete-impersonation-o-auth-token.json b/openapi/ghe-2.15/operations/enterprise-admin/delete-impersonation-o-auth-token.json index 45ec205065..1405b8c208 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/delete-impersonation-o-auth-token.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/delete-impersonation-o-auth-token.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-environment.json b/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-environment.json index 0e699e34cd..b4ab2ade93 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-environment.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-hook.json index 715c5a4e4a..80cf685f60 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/delete-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/delete-public-key.json b/openapi/ghe-2.15/operations/enterprise-admin/delete-public-key.json index dd4073c63e..0b217c4416 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/delete-public-key.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_ids", + "description": "key_ids parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key_ids parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/delete-user.json b/openapi/ghe-2.15/operations/enterprise-admin/delete-user.json index ed6d4bea34..280dbf34d6 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/delete-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/delete-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json b/openapi/ghe-2.15/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json index d16a2396c9..5601760e74 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/enable-or-disable-maintenance-mode.json b/openapi/ghe-2.15/operations/enterprise-admin/enable-or-disable-maintenance-mode.json index 1a12855c42..2105a55f3f 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/enable-or-disable-maintenance-mode.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/enable-or-disable-maintenance-mode.json @@ -81,8 +81,8 @@ "type": "object", "properties": { "maintenance": { - "description": "A JSON string with the attributes `enabled` and `when`.", - "type": "string" + "type": "string", + "description": "A JSON string with the attributes `enabled` and `when`." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-global-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/get-global-hook.json index 9c0c4929ea..e252086cd0 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-global-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment-download-status.json b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment-download-status.json index 2286b6d7b3..c9153f4ca5 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment-download-status.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment-download-status.json @@ -21,39 +21,39 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } }, { "name": "state", + "description": "The state of the most recent download.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The state of the most recent download." + } }, { "name": "downloaded_at", + "description": "The time when the most recent download started.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The time when the most recent download started." + } }, { "name": "message", + "description": "On failure, this will have any error messages produced.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "On failure, this will have any error messages produced." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment.json b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment.json index 16b478b3c0..5121e565fc 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-org.json b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-org.json index c0ce8f0684..087bb72a27 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-org.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-repo.json b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-repo.json index ba7fa0f8f6..e82f1ba6ae 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-repo.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook.json index 63b68674d5..ed2e46afec 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/get-type-stats.json b/openapi/ghe-2.15/operations/enterprise-admin/get-type-stats.json index 03f237f387..40e10af37b 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/get-type-stats.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/get-type-stats.json @@ -21,12 +21,12 @@ }, { "name": "type", + "description": "type parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "type parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/list-global-hooks.json b/openapi/ghe-2.15/operations/enterprise-admin/list-global-hooks.json index 576c5105a1..6423f58253 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/list-global-hooks.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/list-global-hooks.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-environments.json b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-environments.json index 49bbd6dd00..94663f212c 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-environments.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-environments.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-org.json b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-org.json index a69e19df52..d70a4660fa 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-org.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json index a150229c0b..5ffbcf511b 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks.json b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks.json index c37016ad84..8db107ad9a 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/list-pre-receive-hooks.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/modify-settings.json b/openapi/ghe-2.15/operations/enterprise-admin/modify-settings.json index f366ce751b..a2a11a9cc6 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/modify-settings.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/modify-settings.json @@ -48,8 +48,8 @@ "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" + "type": "string", + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/ping-global-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/ping-global-hook.json index 2b03661295..6b7a8db613 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/ping-global-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/ping-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json b/openapi/ghe-2.15/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json index 9cf14f7dec..0fce0497a4 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/queue-indexing-job.json b/openapi/ghe-2.15/operations/enterprise-admin/queue-indexing-job.json index b8679f0ae0..050ce4f7e7 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/queue-indexing-job.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/queue-indexing-job.json @@ -60,8 +60,8 @@ "type": "object", "properties": { "target": { - "description": "A string representing the item to index.", - "type": "string" + "type": "string", + "description": "A string representing the item to index." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/remove-authorized-ssh-key.json b/openapi/ghe-2.15/operations/enterprise-admin/remove-authorized-ssh-key.json index d5a33696be..4720fd98e0 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/remove-authorized-ssh-key.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/remove-authorized-ssh-key.json @@ -66,8 +66,8 @@ "type": "object", "properties": { "authorized_key": { - "description": "The path to the public SSH key.", - "type": "string" + "type": "string", + "description": "The path to the public SSH key." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json b/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json index e915edb19c..a11e1052a5 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json b/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json index ab58c110ad..62ae7cf122 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/rename-org.json b/openapi/ghe-2.15/operations/enterprise-admin/rename-org.json index c6a275f6fe..74aa4cc217 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/rename-org.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/rename-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -72,8 +72,8 @@ "type": "object", "properties": { "login": { - "description": "The organization's new name.", - "type": "string" + "type": "string", + "description": "The organization's new name." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/rename-user.json b/openapi/ghe-2.15/operations/enterprise-admin/rename-user.json index db10c70143..3775ad195f 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/rename-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/rename-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -72,8 +72,8 @@ "type": "object", "properties": { "login": { - "description": "The user's new username.", - "type": "string" + "type": "string", + "description": "The user's new username." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/enterprise-admin/suspend-user.json b/openapi/ghe-2.15/operations/enterprise-admin/suspend-user.json index ceb44f5968..86048c7052 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/suspend-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/suspend-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -57,8 +57,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-team.json b/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-team.json index edd08fb1d9..6cdf6fee16 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-team.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-team.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-user.json b/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-user.json index 67b4d8b9e9..d83a48e317 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/sync-ldap-mapping-for-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/trigger-pre-receive-environment-download.json b/openapi/ghe-2.15/operations/enterprise-admin/trigger-pre-receive-environment-download.json index 6ef827bf23..5739e5d75b 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/trigger-pre-receive-environment-download.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/trigger-pre-receive-environment-download.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/unsuspend-user.json b/openapi/ghe-2.15/operations/enterprise-admin/unsuspend-user.json index ab32d33a6f..506a80edab 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/unsuspend-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/unsuspend-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -57,8 +57,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-global-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/update-global-hook.json index 2d1e153e25..bc1847ba5b 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-global-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -111,24 +111,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.15/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.15/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -136,15 +136,15 @@ ] }, "events": { - "description": "The [events](https://developer.github.com/enterprise/2.15/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", + "description": "The [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-team.json b/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-team.json index 88278f9573..2302c8803d 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-team.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-team.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -102,8 +102,8 @@ "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" + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." } } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-user.json b/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-user.json index 105a6a0dca..ca00b2e993 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-user.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-ldap-mapping-for-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -123,8 +123,8 @@ "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" + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." } } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-environment.json b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-environment.json index 0916931073..a698a53638 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-environment.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "name": { - "description": "This pre-receive environment's new name.", - "type": "string" + "type": "string", + "description": "This pre-receive environment's new name." }, "image_url": { - "description": "URL from which to download a tarball of this environment.", - "type": "string" + "type": "string", + "description": "URL from which to download a tarball of this environment." } } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json index 2c418b7ea8..443059a66e 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json index dbf80c9c95..b98d8dad0d 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook.json b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook.json index 47f1c6e80f..9af9a85653 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/update-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/enterprise-admin/upgrade-license.json b/openapi/ghe-2.15/operations/enterprise-admin/upgrade-license.json index cc38da5a99..4c5aabc86f 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/upgrade-license.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/upgrade-license.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "license": { - "description": "The content of your new _.ghl_ license file.", - "type": "string" + "type": "string", + "description": "The content of your new _.ghl_ license file." } } } diff --git a/openapi/ghe-2.15/operations/enterprise-admin/upload-license-for-first-time.json b/openapi/ghe-2.15/operations/enterprise-admin/upload-license-for-first-time.json index a7fb7be864..9f9441d5fd 100644 --- a/openapi/ghe-2.15/operations/enterprise-admin/upload-license-for-first-time.json +++ b/openapi/ghe-2.15/operations/enterprise-admin/upload-license-for-first-time.json @@ -48,16 +48,16 @@ "type": "object", "properties": { "license": { - "description": "The content of your _.ghl_ license file.", - "type": "string" + "type": "string", + "description": "The content of your _.ghl_ license file." }, "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" + "type": "string", + "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." }, "settings": { - "description": "An optional JSON string containing the installation settings.", - "type": "string" + "type": "string", + "description": "An optional JSON string containing the installation settings." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/gists/check-is-starred.json b/openapi/ghe-2.15/operations/gists/check-is-starred.json index 479ac006c6..4248b83b8c 100644 --- a/openapi/ghe-2.15/operations/gists/check-is-starred.json +++ b/openapi/ghe-2.15/operations/gists/check-is-starred.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/create-comment.json b/openapi/ghe-2.15/operations/gists/create-comment.json index 4780fc580e..70434b8762 100644 --- a/openapi/ghe-2.15/operations/gists/create-comment.json +++ b/openapi/ghe-2.15/operations/gists/create-comment.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -143,8 +143,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/gists/create.json b/openapi/ghe-2.15/operations/gists/create.json index c00842fbfd..b359b7e45d 100644 --- a/openapi/ghe-2.15/operations/gists/create.json +++ b/openapi/ghe-2.15/operations/gists/create.json @@ -442,22 +442,22 @@ "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", + "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`.", "properties": { "content": { - "description": "The content of the file.", - "type": "string" + "type": "string", + "description": "The content of the file." } } }, "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "public": { - "description": "When `true`, the gist will be public and available for anyone to see.", "type": "boolean", + "description": "When `true`, the gist will be public and available for anyone to see.", "default": false } }, diff --git a/openapi/ghe-2.15/operations/gists/delete-comment.json b/openapi/ghe-2.15/operations/gists/delete-comment.json index 0d76b168bf..2de000187d 100644 --- a/openapi/ghe-2.15/operations/gists/delete-comment.json +++ b/openapi/ghe-2.15/operations/gists/delete-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/delete.json b/openapi/ghe-2.15/operations/gists/delete.json index 7ec94f3f9d..4fe3e98745 100644 --- a/openapi/ghe-2.15/operations/gists/delete.json +++ b/openapi/ghe-2.15/operations/gists/delete.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/fork.json b/openapi/ghe-2.15/operations/gists/fork.json index fec2d371c1..9d3a6c89b5 100644 --- a/openapi/ghe-2.15/operations/gists/fork.json +++ b/openapi/ghe-2.15/operations/gists/fork.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/get-comment.json b/openapi/ghe-2.15/operations/gists/get-comment.json index 63719c530e..b07f56e526 100644 --- a/openapi/ghe-2.15/operations/gists/get-comment.json +++ b/openapi/ghe-2.15/operations/gists/get-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/get-revision.json b/openapi/ghe-2.15/operations/gists/get-revision.json index 947afc6101..c4c733b77f 100644 --- a/openapi/ghe-2.15/operations/gists/get-revision.json +++ b/openapi/ghe-2.15/operations/gists/get-revision.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/get.json b/openapi/ghe-2.15/operations/gists/get.json index d95c5dbd4d..ed27bb9270 100644 --- a/openapi/ghe-2.15/operations/gists/get.json +++ b/openapi/ghe-2.15/operations/gists/get.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list-comments.json b/openapi/ghe-2.15/operations/gists/list-comments.json index 1c4468e4f4..50da86a190 100644 --- a/openapi/ghe-2.15/operations/gists/list-comments.json +++ b/openapi/ghe-2.15/operations/gists/list-comments.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list-commits.json b/openapi/ghe-2.15/operations/gists/list-commits.json index 11a6c5e874..f1c8eeb6fc 100644 --- a/openapi/ghe-2.15/operations/gists/list-commits.json +++ b/openapi/ghe-2.15/operations/gists/list-commits.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list-forks.json b/openapi/ghe-2.15/operations/gists/list-forks.json index 1c13486694..147237cc3f 100644 --- a/openapi/ghe-2.15/operations/gists/list-forks.json +++ b/openapi/ghe-2.15/operations/gists/list-forks.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list-public-for-user.json b/openapi/ghe-2.15/operations/gists/list-public-for-user.json index a238c73390..d345191f48 100644 --- a/openapi/ghe-2.15/operations/gists/list-public-for-user.json +++ b/openapi/ghe-2.15/operations/gists/list-public-for-user.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list-public.json b/openapi/ghe-2.15/operations/gists/list-public.json index 7a0cddb2dd..25c997a3d2 100644 --- a/openapi/ghe-2.15/operations/gists/list-public.json +++ b/openapi/ghe-2.15/operations/gists/list-public.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list-starred.json b/openapi/ghe-2.15/operations/gists/list-starred.json index bda0cb5f0f..1aa29e104a 100644 --- a/openapi/ghe-2.15/operations/gists/list-starred.json +++ b/openapi/ghe-2.15/operations/gists/list-starred.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/list.json b/openapi/ghe-2.15/operations/gists/list.json index 139b67773e..fe8f0c2eaf 100644 --- a/openapi/ghe-2.15/operations/gists/list.json +++ b/openapi/ghe-2.15/operations/gists/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/star.json b/openapi/ghe-2.15/operations/gists/star.json index 7f2f6e276f..ee8a09bd86 100644 --- a/openapi/ghe-2.15/operations/gists/star.json +++ b/openapi/ghe-2.15/operations/gists/star.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/unstar.json b/openapi/ghe-2.15/operations/gists/unstar.json index beb5026ffb..d8f11aae92 100644 --- a/openapi/ghe-2.15/operations/gists/unstar.json +++ b/openapi/ghe-2.15/operations/gists/unstar.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/gists/update-comment.json b/openapi/ghe-2.15/operations/gists/update-comment.json index 5ad0f36049..cbab7d14a0 100644 --- a/openapi/ghe-2.15/operations/gists/update-comment.json +++ b/openapi/ghe-2.15/operations/gists/update-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -152,8 +152,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/gists/update.json b/openapi/ghe-2.15/operations/gists/update.json index 51d1ee38a1..33cef07007 100644 --- a/openapi/ghe-2.15/operations/gists/update.json +++ b/openapi/ghe-2.15/operations/gists/update.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -451,20 +451,20 @@ "type": "object", "properties": { "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "files": { - "description": "The filenames and content that make up this gist.", "type": "object", + "description": "The filenames and content that make up this gist.", "properties": { "content": { - "description": "The updated content of the file.", - "type": "string" + "type": "string", + "description": "The updated content of the file." }, "filename": { - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "type": "string" + "type": "string", + "description": "The new name for this file. To delete a file, set the value of the filename to `null`." } } } diff --git a/openapi/ghe-2.15/operations/git/create-blob.json b/openapi/ghe-2.15/operations/git/create-blob.json index baba646e31..78c1e8e85b 100644 --- a/openapi/ghe-2.15/operations/git/create-blob.json +++ b/openapi/ghe-2.15/operations/git/create-blob.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,12 +81,12 @@ "type": "object", "properties": { "content": { - "description": "The new blob's content.", - "type": "string" + "type": "string", + "description": "The new blob's content." }, "encoding": { - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } }, diff --git a/openapi/ghe-2.15/operations/git/create-commit.json b/openapi/ghe-2.15/operations/git/create-commit.json index 2478db440c..a298db705d 100644 --- a/openapi/ghe-2.15/operations/git/create-commit.json +++ b/openapi/ghe-2.15/operations/git/create-commit.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -157,59 +157,59 @@ "type": "object", "properties": { "message": { - "description": "The commit message", - "type": "string" + "type": "string", + "description": "The commit message" }, "tree": { - "description": "The SHA of the tree object this commit points to", - "type": "string" + "type": "string", + "description": "The SHA of the tree object this commit points to" }, "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", + "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.", "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/git/create-ref.json b/openapi/ghe-2.15/operations/git/create-ref.json index 209615a011..6065e40705 100644 --- a/openapi/ghe-2.15/operations/git/create-ref.json +++ b/openapi/ghe-2.15/operations/git/create-ref.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -98,12 +98,12 @@ "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" + "type": "string", + "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." }, "sha": { - "description": "The SHA1 value for this reference.", - "type": "string" + "type": "string", + "description": "The SHA1 value for this reference." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/git/create-tag.json b/openapi/ghe-2.15/operations/git/create-tag.json index 35eaaa30dc..65bb2932dc 100644 --- a/openapi/ghe-2.15/operations/git/create-tag.json +++ b/openapi/ghe-2.15/operations/git/create-tag.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -135,20 +135,20 @@ "type": "object", "properties": { "tag": { - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "type": "string" + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." }, "message": { - "description": "The tag message.", - "type": "string" + "type": "string", + "description": "The tag message." }, "object": { - "description": "The SHA of the git object this is tagging.", - "type": "string" + "type": "string", + "description": "The SHA of the git object this is tagging." }, "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", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", "enum": [ "commit", "tree", @@ -156,20 +156,20 @@ ] }, "tagger": { - "description": "An object with information about the individual creating the tag.", "type": "object", + "description": "An object with information about the individual creating the tag.", "properties": { "name": { - "description": "The name of the author of the tag", - "type": "string" + "type": "string", + "description": "The name of the author of the tag" }, "email": { - "description": "The email of the author of the tag", - "type": "string" + "type": "string", + "description": "The email of the author of the tag" }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/ghe-2.15/operations/git/create-tree.json b/openapi/ghe-2.15/operations/git/create-tree.json index 96db419342..424feccb59 100644 --- a/openapi/ghe-2.15/operations/git/create-tree.json +++ b/openapi/ghe-2.15/operations/git/create-tree.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -107,18 +107,18 @@ "type": "object", "properties": { "tree": { - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "items": { "type": "object", "properties": { "path": { - "description": "The file referenced in the tree.", - "type": "string" + "type": "string", + "description": "The file referenced in the tree." }, "mode": { - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", "type": "string", + "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.", "enum": [ "100644", "100755", @@ -128,8 +128,8 @@ ] }, "type": { - "description": "Either `blob`, `tree`, or `commit`.", "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", "enum": [ "blob", "tree", @@ -137,19 +137,19 @@ ] }, "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" + "type": "string", + "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." }, "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" + "type": "string", + "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." } } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/git/delete-ref.json b/openapi/ghe-2.15/operations/git/delete-ref.json index 114e9bb7dc..bab38dafb7 100644 --- a/openapi/ghe-2.15/operations/git/delete-ref.json +++ b/openapi/ghe-2.15/operations/git/delete-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/git/get-blob.json b/openapi/ghe-2.15/operations/git/get-blob.json index c8bc9a7597..55507814c1 100644 --- a/openapi/ghe-2.15/operations/git/get-blob.json +++ b/openapi/ghe-2.15/operations/git/get-blob.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "file_sha", + "description": "file_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "file_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/git/get-commit.json b/openapi/ghe-2.15/operations/git/get-commit.json index d22890a7a6..0b5bbd5ace 100644 --- a/openapi/ghe-2.15/operations/git/get-commit.json +++ b/openapi/ghe-2.15/operations/git/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/git/get-tag.json b/openapi/ghe-2.15/operations/git/get-tag.json index 8dbea84c8c..3413dcc3a0 100644 --- a/openapi/ghe-2.15/operations/git/get-tag.json +++ b/openapi/ghe-2.15/operations/git/get-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag_sha", + "description": "tag_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/git/get-tree.json b/openapi/ghe-2.15/operations/git/get-tree.json index b4c2ec3207..3d2d11b807 100644 --- a/openapi/ghe-2.15/operations/git/get-tree.json +++ b/openapi/ghe-2.15/operations/git/get-tree.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-tree", "tags": [ "git" ], @@ -21,41 +21,41 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tree_sha", + "description": "tree_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tree_sha parameter" + } }, { "name": "recursive", + "description": "recursive parameter", "in": "query", "schema": { "type": "integer", "enum": [ 1 ] - }, - "description": "recursive parameter" + } } ], "responses": { @@ -70,7 +70,7 @@ }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" + "source": "octokit.git.getTree({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" } ], "x-github": { diff --git a/openapi/ghe-2.15/operations/git/update-ref.json b/openapi/ghe-2.15/operations/git/update-ref.json index f0e64f5890..40520a30ae 100644 --- a/openapi/ghe-2.15/operations/git/update-ref.json +++ b/openapi/ghe-2.15/operations/git/update-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "sha": { - "description": "The SHA1 value to set this reference to", - "type": "string" + "type": "string", + "description": "The SHA1 value to set this reference to" }, "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.15/operations/gitignore/get-template.json b/openapi/ghe-2.15/operations/gitignore/get-template.json index 77e35efd80..e2612351a5 100644 --- a/openapi/ghe-2.15/operations/gitignore/get-template.json +++ b/openapi/ghe-2.15/operations/gitignore/get-template.json @@ -21,12 +21,12 @@ }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/add-assignees.json b/openapi/ghe-2.15/operations/issues/add-assignees.json index 6681aaf7cf..a97a687a43 100644 --- a/openapi/ghe-2.15/operations/issues/add-assignees.json +++ b/openapi/ghe-2.15/operations/issues/add-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -503,8 +503,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/issues/add-labels.json b/openapi/ghe-2.15/operations/issues/add-labels.json index 50704b8e78..f15e58888e 100644 --- a/openapi/ghe-2.15/operations/issues/add-labels.json +++ b/openapi/ghe-2.15/operations/issues/add-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/check-assignee.json b/openapi/ghe-2.15/operations/issues/check-assignee.json index 44ce039df9..cb5a12052f 100644 --- a/openapi/ghe-2.15/operations/issues/check-assignee.json +++ b/openapi/ghe-2.15/operations/issues/check-assignee.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "assignee", + "description": "assignee parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "assignee parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/create-comment.json b/openapi/ghe-2.15/operations/issues/create-comment.json index be74faaeaf..429384ad60 100644 --- a/openapi/ghe-2.15/operations/issues/create-comment.json +++ b/openapi/ghe-2.15/operations/issues/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -175,8 +175,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/issues/create-label.json b/openapi/ghe-2.15/operations/issues/create-label.json index eb5d6a85d7..f92724bb85 100644 --- a/openapi/ghe-2.15/operations/issues/create-label.json +++ b/openapi/ghe-2.15/operations/issues/create-label.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "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" + "type": "string", + "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/)." }, "color": { - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "type": "string" + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." }, "description": { - "description": "A short description of the label.", - "type": "string" + "type": "string", + "description": "A short description of the label." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/issues/create-milestone.json b/openapi/ghe-2.15/operations/issues/create-milestone.json index 0f3fe4f59b..ad9a1d7d05 100644 --- a/openapi/ghe-2.15/operations/issues/create-milestone.json +++ b/openapi/ghe-2.15/operations/issues/create-milestone.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -192,12 +192,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/issues/create.json b/openapi/ghe-2.15/operations/issues/create.json index 55b728fe00..3df0624ee0 100644 --- a/openapi/ghe-2.15/operations/issues/create.json +++ b/openapi/ghe-2.15/operations/issues/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -524,31 +524,31 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "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" + "type": "string", + "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.**_" }, "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" + "type": "integer", + "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._" }, "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", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/issues/delete-comment.json b/openapi/ghe-2.15/operations/issues/delete-comment.json index 22180b9b94..c5fbdd1a7e 100644 --- a/openapi/ghe-2.15/operations/issues/delete-comment.json +++ b/openapi/ghe-2.15/operations/issues/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/delete-label.json b/openapi/ghe-2.15/operations/issues/delete-label.json index ac513c99cb..e1a34727c8 100644 --- a/openapi/ghe-2.15/operations/issues/delete-label.json +++ b/openapi/ghe-2.15/operations/issues/delete-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/delete-milestone.json b/openapi/ghe-2.15/operations/issues/delete-milestone.json index 4ff791c6cd..5094e234d2 100644 --- a/openapi/ghe-2.15/operations/issues/delete-milestone.json +++ b/openapi/ghe-2.15/operations/issues/delete-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/get-comment.json b/openapi/ghe-2.15/operations/issues/get-comment.json index 8d52a04288..b5f112f1c0 100644 --- a/openapi/ghe-2.15/operations/issues/get-comment.json +++ b/openapi/ghe-2.15/operations/issues/get-comment.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/get-event.json b/openapi/ghe-2.15/operations/issues/get-event.json index 8ae7953a37..65fc9371bd 100644 --- a/openapi/ghe-2.15/operations/issues/get-event.json +++ b/openapi/ghe-2.15/operations/issues/get-event.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "event_id", + "description": "event_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "event_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/get-label.json b/openapi/ghe-2.15/operations/issues/get-label.json index e13b46aadf..5b05801e92 100644 --- a/openapi/ghe-2.15/operations/issues/get-label.json +++ b/openapi/ghe-2.15/operations/issues/get-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/get-milestone.json b/openapi/ghe-2.15/operations/issues/get-milestone.json index 4f2c40710f..3eb2fa4caf 100644 --- a/openapi/ghe-2.15/operations/issues/get-milestone.json +++ b/openapi/ghe-2.15/operations/issues/get-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/get.json b/openapi/ghe-2.15/operations/issues/get.json index 2255ae2a72..4de75c6e89 100644 --- a/openapi/ghe-2.15/operations/issues/get.json +++ b/openapi/ghe-2.15/operations/issues/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-assignees.json b/openapi/ghe-2.15/operations/issues/list-assignees.json index f4f94ed904..c466395789 100644 --- a/openapi/ghe-2.15/operations/issues/list-assignees.json +++ b/openapi/ghe-2.15/operations/issues/list-assignees.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-comments-for-repo.json b/openapi/ghe-2.15/operations/issues/list-comments-for-repo.json index f0a3275bb7..9a5015cc86 100644 --- a/openapi/ghe-2.15/operations/issues/list-comments-for-repo.json +++ b/openapi/ghe-2.15/operations/issues/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Either `created` or `updated`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,31 +49,29 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Either `created` or `updated`." + } }, { "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter." + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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": { diff --git a/openapi/ghe-2.15/operations/issues/list-comments.json b/openapi/ghe-2.15/operations/issues/list-comments.json index cf5367852c..dd40c2916d 100644 --- a/openapi/ghe-2.15/operations/issues/list-comments.json +++ b/openapi/ghe-2.15/operations/issues/list-comments.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-events-for-repo.json b/openapi/ghe-2.15/operations/issues/list-events-for-repo.json index 15932a82e9..b6a20b1131 100644 --- a/openapi/ghe-2.15/operations/issues/list-events-for-repo.json +++ b/openapi/ghe-2.15/operations/issues/list-events-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-events-for-timeline.json b/openapi/ghe-2.15/operations/issues/list-events-for-timeline.json index a96fd6acd9..6249fbd639 100644 --- a/openapi/ghe-2.15/operations/issues/list-events-for-timeline.json +++ b/openapi/ghe-2.15/operations/issues/list-events-for-timeline.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-events.json b/openapi/ghe-2.15/operations/issues/list-events.json index aaad707866..bc17c00b05 100644 --- a/openapi/ghe-2.15/operations/issues/list-events.json +++ b/openapi/ghe-2.15/operations/issues/list-events.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-for-authenticated-user.json b/openapi/ghe-2.15/operations/issues/list-for-authenticated-user.json index c964b3eac0..978ba9d77d 100644 --- a/openapi/ghe-2.15/operations/issues/list-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/issues/list-for-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-for-org.json b/openapi/ghe-2.15/operations/issues/list-for-org.json index abbe46c0c0..b4e257f5e4 100644 --- a/openapi/ghe-2.15/operations/issues/list-for-org.json +++ b/openapi/ghe-2.15/operations/issues/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -41,13 +43,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,13 +82,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -94,38 +96,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-for-repo.json b/openapi/ghe-2.15/operations/issues/list-for-repo.json index e891b5973e..ba3a4faea9 100644 --- a/openapi/ghe-2.15/operations/issues/list-for-repo.json +++ b/openapi/ghe-2.15/operations/issues/list-for-repo.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone", + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", "in": "query", + "required": false, "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,49 +59,49 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", "in": "query", + "required": false, "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", + "description": "The user that created the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The user that created the issue." + } }, { "name": "mentioned", + "description": "A user that's mentioned in the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A user that's mentioned in the issue." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -108,13 +110,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -122,38 +124,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-labels-for-milestone.json b/openapi/ghe-2.15/operations/issues/list-labels-for-milestone.json index ba5239507b..0346a48697 100644 --- a/openapi/ghe-2.15/operations/issues/list-labels-for-milestone.json +++ b/openapi/ghe-2.15/operations/issues/list-labels-for-milestone.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-labels-for-repo.json b/openapi/ghe-2.15/operations/issues/list-labels-for-repo.json index b4aa6727dd..1bd03f5694 100644 --- a/openapi/ghe-2.15/operations/issues/list-labels-for-repo.json +++ b/openapi/ghe-2.15/operations/issues/list-labels-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-labels-on-issue.json b/openapi/ghe-2.15/operations/issues/list-labels-on-issue.json index ec2256041f..74faaf713f 100644 --- a/openapi/ghe-2.15/operations/issues/list-labels-on-issue.json +++ b/openapi/ghe-2.15/operations/issues/list-labels-on-issue.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list-milestones-for-repo.json b/openapi/ghe-2.15/operations/issues/list-milestones-for-repo.json index e4fd2d12d9..3987cd2fbe 100644 --- a/openapi/ghe-2.15/operations/issues/list-milestones-for-repo.json +++ b/openapi/ghe-2.15/operations/issues/list-milestones-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,13 +50,13 @@ "all" ], "default": "open" - }, - "required": false, - "description": "The state of the milestone. Either `open`, `closed`, or `all`." + } }, { "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,13 +64,13 @@ "completeness" ], "default": "due_on" - }, - "required": false, - "description": "What to sort results by. Either `due_on` or `completeness`." + } }, { "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -76,29 +78,25 @@ "desc" ], "default": "asc" - }, - "required": false, - "description": "The direction of the sort. Either `asc` or `desc`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/list.json b/openapi/ghe-2.15/operations/issues/list.json index 010c7f1c63..c97856a95a 100644 --- a/openapi/ghe-2.15/operations/issues/list.json +++ b/openapi/ghe-2.15/operations/issues/list.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/lock.json b/openapi/ghe-2.15/operations/issues/lock.json index 42e415a085..752371f514 100644 --- a/openapi/ghe-2.15/operations/issues/lock.json +++ b/openapi/ghe-2.15/operations/issues/lock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -85,8 +85,8 @@ "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", + "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`", "enum": [ "off-topic", "too heated", diff --git a/openapi/ghe-2.15/operations/issues/remove-assignees.json b/openapi/ghe-2.15/operations/issues/remove-assignees.json index 38a485cda1..a49c9b9a89 100644 --- a/openapi/ghe-2.15/operations/issues/remove-assignees.json +++ b/openapi/ghe-2.15/operations/issues/remove-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -483,8 +483,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/issues/remove-label.json b/openapi/ghe-2.15/operations/issues/remove-label.json index 1c326fbb66..bc42e950b7 100644 --- a/openapi/ghe-2.15/operations/issues/remove-label.json +++ b/openapi/ghe-2.15/operations/issues/remove-label.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/remove-labels.json b/openapi/ghe-2.15/operations/issues/remove-labels.json index 8683fd5c88..6aa8556213 100644 --- a/openapi/ghe-2.15/operations/issues/remove-labels.json +++ b/openapi/ghe-2.15/operations/issues/remove-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/replace-labels.json b/openapi/ghe-2.15/operations/issues/replace-labels.json index 2f4d9ae50b..3a2d9ce68e 100644 --- a/openapi/ghe-2.15/operations/issues/replace-labels.json +++ b/openapi/ghe-2.15/operations/issues/replace-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/unlock.json b/openapi/ghe-2.15/operations/issues/unlock.json index 1bb4b2a60a..86f46c8fcf 100644 --- a/openapi/ghe-2.15/operations/issues/unlock.json +++ b/openapi/ghe-2.15/operations/issues/unlock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/issues/update-comment.json b/openapi/ghe-2.15/operations/issues/update-comment.json index df2e9f6285..067c23d47e 100644 --- a/openapi/ghe-2.15/operations/issues/update-comment.json +++ b/openapi/ghe-2.15/operations/issues/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -164,8 +164,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/issues/update-milestone.json b/openapi/ghe-2.15/operations/issues/update-milestone.json index f8fd30a1f9..c296577024 100644 --- a/openapi/ghe-2.15/operations/issues/update-milestone.json +++ b/openapi/ghe-2.15/operations/issues/update-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { @@ -198,12 +198,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -211,12 +211,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/ghe-2.15/operations/issues/update.json b/openapi/ghe-2.15/operations/issues/update.json index e8caf3c5a9..459864f4c1 100644 --- a/openapi/ghe-2.15/operations/issues/update.json +++ b/openapi/ghe-2.15/operations/issues/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -542,40 +542,40 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "assignee": { - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "type": "string" + "type": "string", + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**" }, "state": { - "description": "State of the issue. Either `open` or `closed`.", "type": "string", + "description": "State of the issue. Either `open` or `closed`.", "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", + "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._", "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", + "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._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/licenses/get-for-repo.json b/openapi/ghe-2.15/operations/licenses/get-for-repo.json index 9f146f2eba..b5f9b3a5ea 100644 --- a/openapi/ghe-2.15/operations/licenses/get-for-repo.json +++ b/openapi/ghe-2.15/operations/licenses/get-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/licenses/get.json b/openapi/ghe-2.15/operations/licenses/get.json index 5a95ea0dbf..8666727fd6 100644 --- a/openapi/ghe-2.15/operations/licenses/get.json +++ b/openapi/ghe-2.15/operations/licenses/get.json @@ -21,12 +21,12 @@ }, { "name": "license", + "description": "license parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "license parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/markdown/render.json b/openapi/ghe-2.15/operations/markdown/render.json index 175aa1ba32..7cfaee66f2 100644 --- a/openapi/ghe-2.15/operations/markdown/render.json +++ b/openapi/ghe-2.15/operations/markdown/render.json @@ -48,12 +48,12 @@ "type": "object", "properties": { "text": { - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "type": "string" + "type": "string", + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less." }, "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", + "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.", "enum": [ "markdown", "gfm" @@ -61,8 +61,8 @@ "default": "markdown" }, "context": { - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", - "type": "string" + "type": "string", + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/check-authorization.json b/openapi/ghe-2.15/operations/oauth-authorizations/check-authorization.json index 6598885a15..ebff81a469 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/check-authorization.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/check-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/create-authorization.json b/openapi/ghe-2.15/operations/oauth-authorizations/create-authorization.json index 83e7ef4c5c..2022b8bb0d 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/create-authorization.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/create-authorization.json @@ -107,31 +107,31 @@ "type": "object", "properties": { "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "client_id": { - "description": "The 20 character OAuth app client key for which to create the token.", - "type": "string" + "type": "string", + "description": "The 20 character OAuth app client key for which to create the token." }, "client_secret": { - "description": "The 40 character OAuth app client secret for which to create the token.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret for which to create the token." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/delete-authorization.json b/openapi/ghe-2.15/operations/oauth-authorizations/delete-authorization.json index d9d310ac8d..afc602d6f3 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/delete-authorization.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/delete-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/delete-grant.json b/openapi/ghe-2.15/operations/oauth-authorizations/delete-grant.json index b273aacbee..73247ee21a 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/delete-grant.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/delete-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/get-authorization.json b/openapi/ghe-2.15/operations/oauth-authorizations/get-authorization.json index fcc7dad789..7bd006c23f 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/get-authorization.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/get-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/get-grant.json b/openapi/ghe-2.15/operations/oauth-authorizations/get-grant.json index 5a4a9b2142..b73bc01f24 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/get-grant.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/get-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json b/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json index cbcfdf56e5..256c23ccaf 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "fingerprint", + "description": "fingerprint parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "fingerprint parameter" + } } ], "responses": { @@ -80,23 +80,23 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app.json b/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app.json index 3bbd4edb0d..53ca742641 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/get-or-create-authorization-for-app.json @@ -21,12 +21,12 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } } ], "responses": { @@ -57,27 +57,27 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "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.15/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", - "type": "string" + "type": "string", + "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.15/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint)." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/list-authorizations.json b/openapi/ghe-2.15/operations/oauth-authorizations/list-authorizations.json index 45870efd1e..2ac8e0d206 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/list-authorizations.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/list-authorizations.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/list-grants.json b/openapi/ghe-2.15/operations/oauth-authorizations/list-grants.json index 97f9e338c6..828ecb3549 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/list-grants.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/list-grants.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/reset-authorization.json b/openapi/ghe-2.15/operations/oauth-authorizations/reset-authorization.json index 848d7c2c4a..273056f4a1 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/reset-authorization.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/reset-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/revoke-authorization-for-application.json b/openapi/ghe-2.15/operations/oauth-authorizations/revoke-authorization-for-application.json index 3abe07e0b2..4a49a03a6c 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/revoke-authorization-for-application.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/revoke-authorization-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/revoke-grant-for-application.json b/openapi/ghe-2.15/operations/oauth-authorizations/revoke-grant-for-application.json index 239bf32269..239ec8b24c 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/revoke-grant-for-application.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/revoke-grant-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/oauth-authorizations/update-authorization.json b/openapi/ghe-2.15/operations/oauth-authorizations/update-authorization.json index 01dfe9c2a1..25fe93f70b 100644 --- a/openapi/ghe-2.15/operations/oauth-authorizations/update-authorization.json +++ b/openapi/ghe-2.15/operations/oauth-authorizations/update-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { @@ -116,37 +116,37 @@ "type": "object", "properties": { "scopes": { - "description": "Replaces the authorization scopes with these.", "type": "array", + "description": "Replaces the authorization scopes with these.", "items": { "type": "string" } }, "add_scopes": { - "description": "A list of scopes to add to this authorization.", "type": "array", + "description": "A list of scopes to add to this authorization.", "items": { "type": "string" } }, "remove_scopes": { - "description": "A list of scopes to remove from this authorization.", "type": "array", + "description": "A list of scopes to remove from this authorization.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } } } diff --git a/openapi/ghe-2.15/operations/orgs/add-or-update-membership.json b/openapi/ghe-2.15/operations/orgs/add-or-update-membership.json index 1cb0efe07b..634aee9d78 100644 --- a/openapi/ghe-2.15/operations/orgs/add-or-update-membership.json +++ b/openapi/ghe-2.15/operations/orgs/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -187,8 +187,8 @@ "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", + "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.", "enum": [ "admin", "member" diff --git a/openapi/ghe-2.15/operations/orgs/check-membership.json b/openapi/ghe-2.15/operations/orgs/check-membership.json index 8b98f98043..0266ebbe60 100644 --- a/openapi/ghe-2.15/operations/orgs/check-membership.json +++ b/openapi/ghe-2.15/operations/orgs/check-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/check-public-membership.json b/openapi/ghe-2.15/operations/orgs/check-public-membership.json index 6a865d673d..cafe84fc3c 100644 --- a/openapi/ghe-2.15/operations/orgs/check-public-membership.json +++ b/openapi/ghe-2.15/operations/orgs/check-public-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/conceal-membership.json b/openapi/ghe-2.15/operations/orgs/conceal-membership.json index e33db666ac..e41bf10291 100644 --- a/openapi/ghe-2.15/operations/orgs/conceal-membership.json +++ b/openapi/ghe-2.15/operations/orgs/conceal-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/convert-member-to-outside-collaborator.json b/openapi/ghe-2.15/operations/orgs/convert-member-to-outside-collaborator.json index 330468e883..eaa8604f4f 100644 --- a/openapi/ghe-2.15/operations/orgs/convert-member-to-outside-collaborator.json +++ b/openapi/ghe-2.15/operations/orgs/convert-member-to-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/create-hook.json b/openapi/ghe-2.15/operations/orgs/create-hook.json index 3354c7f491..d1b18f3df5 100644 --- a/openapi/ghe-2.15/operations/orgs/create-hook.json +++ b/openapi/ghe-2.15/operations/orgs/create-hook.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -104,28 +104,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/orgs/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/orgs/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.15/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.15/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -133,8 +133,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -143,8 +143,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/orgs/delete-hook.json b/openapi/ghe-2.15/operations/orgs/delete-hook.json index 70f2957dc3..5b3cc6fc2e 100644 --- a/openapi/ghe-2.15/operations/orgs/delete-hook.json +++ b/openapi/ghe-2.15/operations/orgs/delete-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/get-hook.json b/openapi/ghe-2.15/operations/orgs/get-hook.json index 3733e31798..9ce232ce25 100644 --- a/openapi/ghe-2.15/operations/orgs/get-hook.json +++ b/openapi/ghe-2.15/operations/orgs/get-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/get-membership-for-authenticated-user.json b/openapi/ghe-2.15/operations/orgs/get-membership-for-authenticated-user.json index 1dfe1feb3c..2346e8b55b 100644 --- a/openapi/ghe-2.15/operations/orgs/get-membership-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/orgs/get-membership-for-authenticated-user.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/get-membership.json b/openapi/ghe-2.15/operations/orgs/get-membership.json index d70f67d73f..b8954b5da9 100644 --- a/openapi/ghe-2.15/operations/orgs/get-membership.json +++ b/openapi/ghe-2.15/operations/orgs/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/get.json b/openapi/ghe-2.15/operations/orgs/get.json index e53ae7ee40..f9fe0239f7 100644 --- a/openapi/ghe-2.15/operations/orgs/get.json +++ b/openapi/ghe-2.15/operations/orgs/get.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-for-authenticated-user.json b/openapi/ghe-2.15/operations/orgs/list-for-authenticated-user.json index b6a3673fd0..bb7b24af67 100644 --- a/openapi/ghe-2.15/operations/orgs/list-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/orgs/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-for-user.json b/openapi/ghe-2.15/operations/orgs/list-for-user.json index 168e274470..d8a0922f67 100644 --- a/openapi/ghe-2.15/operations/orgs/list-for-user.json +++ b/openapi/ghe-2.15/operations/orgs/list-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-hooks.json b/openapi/ghe-2.15/operations/orgs/list-hooks.json index ab4e6881e5..63051b465b 100644 --- a/openapi/ghe-2.15/operations/orgs/list-hooks.json +++ b/openapi/ghe-2.15/operations/orgs/list-hooks.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-members.json b/openapi/ghe-2.15/operations/orgs/list-members.json index 32dac950a9..9ac2f394f4 100644 --- a/openapi/ghe-2.15/operations/orgs/list-members.json +++ b/openapi/ghe-2.15/operations/orgs/list-members.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "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", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-memberships.json b/openapi/ghe-2.15/operations/orgs/list-memberships.json index c83d2e9973..1ac891fade 100644 --- a/openapi/ghe-2.15/operations/orgs/list-memberships.json +++ b/openapi/ghe-2.15/operations/orgs/list-memberships.json @@ -21,36 +21,34 @@ }, { "name": "state", + "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.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-outside-collaborators.json b/openapi/ghe-2.15/operations/orgs/list-outside-collaborators.json index 84aef457bc..9694242086 100644 --- a/openapi/ghe-2.15/operations/orgs/list-outside-collaborators.json +++ b/openapi/ghe-2.15/operations/orgs/list-outside-collaborators.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,29 +40,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list-public-members.json b/openapi/ghe-2.15/operations/orgs/list-public-members.json index fe31193f78..72055824c7 100644 --- a/openapi/ghe-2.15/operations/orgs/list-public-members.json +++ b/openapi/ghe-2.15/operations/orgs/list-public-members.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/list.json b/openapi/ghe-2.15/operations/orgs/list.json index 61ee7e7949..a1fb504271 100644 --- a/openapi/ghe-2.15/operations/orgs/list.json +++ b/openapi/ghe-2.15/operations/orgs/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last Organization that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Organization that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/ping-hook.json b/openapi/ghe-2.15/operations/orgs/ping-hook.json index f1ece89a08..4b3acf01ab 100644 --- a/openapi/ghe-2.15/operations/orgs/ping-hook.json +++ b/openapi/ghe-2.15/operations/orgs/ping-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/publicize-membership.json b/openapi/ghe-2.15/operations/orgs/publicize-membership.json index 76d502c4cd..fbfa95eb84 100644 --- a/openapi/ghe-2.15/operations/orgs/publicize-membership.json +++ b/openapi/ghe-2.15/operations/orgs/publicize-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/remove-member.json b/openapi/ghe-2.15/operations/orgs/remove-member.json index 70b72fe076..da4bc04573 100644 --- a/openapi/ghe-2.15/operations/orgs/remove-member.json +++ b/openapi/ghe-2.15/operations/orgs/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/remove-membership.json b/openapi/ghe-2.15/operations/orgs/remove-membership.json index 6870e10afd..04b2211ee0 100644 --- a/openapi/ghe-2.15/operations/orgs/remove-membership.json +++ b/openapi/ghe-2.15/operations/orgs/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/remove-outside-collaborator.json b/openapi/ghe-2.15/operations/orgs/remove-outside-collaborator.json index c60d02d783..cbb4e51065 100644 --- a/openapi/ghe-2.15/operations/orgs/remove-outside-collaborator.json +++ b/openapi/ghe-2.15/operations/orgs/remove-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/orgs/update-hook.json b/openapi/ghe-2.15/operations/orgs/update-hook.json index 6c6fa4b35e..7e38b92187 100644 --- a/openapi/ghe-2.15/operations/orgs/update-hook.json +++ b/openapi/ghe-2.15/operations/orgs/update-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -113,24 +113,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/orgs/hooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/orgs/hooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.15/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.15/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -138,8 +138,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -148,8 +148,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.15/operations/orgs/update-membership.json b/openapi/ghe-2.15/operations/orgs/update-membership.json index 3481dbb303..50364bb937 100644 --- a/openapi/ghe-2.15/operations/orgs/update-membership.json +++ b/openapi/ghe-2.15/operations/orgs/update-membership.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -178,8 +178,8 @@ "type": "object", "properties": { "state": { - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "type": "string", + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "enum": [ "active" ] diff --git a/openapi/ghe-2.15/operations/orgs/update.json b/openapi/ghe-2.15/operations/orgs/update.json index dc90af55c7..63eca55a50 100644 --- a/openapi/ghe-2.15/operations/orgs/update.json +++ b/openapi/ghe-2.15/operations/orgs/update.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -185,40 +185,40 @@ "type": "object", "properties": { "billing_email": { - "description": "Billing email address. This address is not publicized.", - "type": "string" + "type": "string", + "description": "Billing email address. This address is not publicized." }, "company": { - "description": "The company name.", - "type": "string" + "type": "string", + "description": "The company name." }, "email": { - "description": "The publicly visible email address.", - "type": "string" + "type": "string", + "description": "The publicly visible email address." }, "location": { - "description": "The location.", - "type": "string" + "type": "string", + "description": "The location." }, "name": { - "description": "The shorthand name of the company.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, "description": { - "description": "The description of the company.", - "type": "string" + "type": "string", + "description": "The description of the company." }, "has_organization_projects": { - "description": "Toggles whether organization projects are enabled for the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether organization projects are enabled for the organization." }, "has_repository_projects": { - "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization." }, "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", + "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.", "enum": [ "read", "write", @@ -228,8 +228,8 @@ "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", + "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.", "default": true } } diff --git a/openapi/ghe-2.15/operations/projects/add-collaborator.json b/openapi/ghe-2.15/operations/projects/add-collaborator.json index 2d3c5a4a31..8467754cd1 100644 --- a/openapi/ghe-2.15/operations/projects/add-collaborator.json +++ b/openapi/ghe-2.15/operations/projects/add-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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.15/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", + "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.15/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.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.15/operations/projects/create-card.json b/openapi/ghe-2.15/operations/projects/create-card.json index 2869806c17..ec5f2223d3 100644 --- a/openapi/ghe-2.15/operations/projects/create-card.json +++ b/openapi/ghe-2.15/operations/projects/create-card.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -156,16 +156,16 @@ "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" + "type": "string", + "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`." }, "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.15/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.15/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" + "type": "integer", + "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.15/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.15/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`." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.15/operations/projects/create-column.json b/openapi/ghe-2.15/operations/projects/create-column.json index 04c56db79c..c671e75cda 100644 --- a/openapi/ghe-2.15/operations/projects/create-column.json +++ b/openapi/ghe-2.15/operations/projects/create-column.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The name of the column.", - "type": "string" + "type": "string", + "description": "The name of the column." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/projects/create-for-org.json b/openapi/ghe-2.15/operations/projects/create-for-org.json index 03d4eef6cb..8076c0c3b5 100644 --- a/openapi/ghe-2.15/operations/projects/create-for-org.json +++ b/openapi/ghe-2.15/operations/projects/create-for-org.json @@ -22,32 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,12 +180,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/projects/create-for-repo.json b/openapi/ghe-2.15/operations/projects/create-for-repo.json index d461567b6d..8e8a568bee 100644 --- a/openapi/ghe-2.15/operations/projects/create-for-repo.json +++ b/openapi/ghe-2.15/operations/projects/create-for-repo.json @@ -22,41 +22,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -191,12 +189,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/projects/delete-card.json b/openapi/ghe-2.15/operations/projects/delete-card.json index 7bde9739a6..cfeadbdf99 100644 --- a/openapi/ghe-2.15/operations/projects/delete-card.json +++ b/openapi/ghe-2.15/operations/projects/delete-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/delete-column.json b/openapi/ghe-2.15/operations/projects/delete-column.json index 8b01e93275..afb21f6b87 100644 --- a/openapi/ghe-2.15/operations/projects/delete-column.json +++ b/openapi/ghe-2.15/operations/projects/delete-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/delete.json b/openapi/ghe-2.15/operations/projects/delete.json index 5f54a2d8c8..5788bdcfed 100644 --- a/openapi/ghe-2.15/operations/projects/delete.json +++ b/openapi/ghe-2.15/operations/projects/delete.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/get-card.json b/openapi/ghe-2.15/operations/projects/get-card.json index 03a68dd2bc..f68d48e4ac 100644 --- a/openapi/ghe-2.15/operations/projects/get-card.json +++ b/openapi/ghe-2.15/operations/projects/get-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/get-column.json b/openapi/ghe-2.15/operations/projects/get-column.json index f7f584227b..c77dad6622 100644 --- a/openapi/ghe-2.15/operations/projects/get-column.json +++ b/openapi/ghe-2.15/operations/projects/get-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/get.json b/openapi/ghe-2.15/operations/projects/get.json index 307387a844..adf0668cd6 100644 --- a/openapi/ghe-2.15/operations/projects/get.json +++ b/openapi/ghe-2.15/operations/projects/get.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/list-cards.json b/openapi/ghe-2.15/operations/projects/list-cards.json index 9f9e487afe..587fa2ca72 100644 --- a/openapi/ghe-2.15/operations/projects/list-cards.json +++ b/openapi/ghe-2.15/operations/projects/list-cards.json @@ -22,16 +22,18 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } }, { "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "not_archived" ], "default": "not_archived" - }, - "required": false, - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/list-collaborators.json b/openapi/ghe-2.15/operations/projects/list-collaborators.json index 23fe987189..fc24edf7e9 100644 --- a/openapi/ghe-2.15/operations/projects/list-collaborators.json +++ b/openapi/ghe-2.15/operations/projects/list-collaborators.json @@ -22,16 +22,18 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/list-columns.json b/openapi/ghe-2.15/operations/projects/list-columns.json index 620fe165c2..45388d00d8 100644 --- a/openapi/ghe-2.15/operations/projects/list-columns.json +++ b/openapi/ghe-2.15/operations/projects/list-columns.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/list-for-org.json b/openapi/ghe-2.15/operations/projects/list-for-org.json index f145672249..e165edd821 100644 --- a/openapi/ghe-2.15/operations/projects/list-for-org.json +++ b/openapi/ghe-2.15/operations/projects/list-for-org.json @@ -22,16 +22,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/list-for-repo.json b/openapi/ghe-2.15/operations/projects/list-for-repo.json index 5e99f0f377..c212d8e119 100644 --- a/openapi/ghe-2.15/operations/projects/list-for-repo.json +++ b/openapi/ghe-2.15/operations/projects/list-for-repo.json @@ -22,25 +22,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -49,29 +51,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/move-card.json b/openapi/ghe-2.15/operations/projects/move-card.json index ca30d79f1e..f07d70abea 100644 --- a/openapi/ghe-2.15/operations/projects/move-card.json +++ b/openapi/ghe-2.15/operations/projects/move-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,13 +58,13 @@ "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", + "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`.", "pattern": "^(top|bottom|after:\\d+)$" }, "column_id": { - "description": "The `id` value of a column in the same project.", - "type": "integer" + "type": "integer", + "description": "The `id` value of a column in the same project." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/projects/move-column.json b/openapi/ghe-2.15/operations/projects/move-column.json index 7a97450f5c..d813b1ae9f 100644 --- a/openapi/ghe-2.15/operations/projects/move-column.json +++ b/openapi/ghe-2.15/operations/projects/move-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "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", + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", "pattern": "^(first|last|after:\\d+)$" } }, diff --git a/openapi/ghe-2.15/operations/projects/remove-collaborator.json b/openapi/ghe-2.15/operations/projects/remove-collaborator.json index 5c906c0267..637ae843a1 100644 --- a/openapi/ghe-2.15/operations/projects/remove-collaborator.json +++ b/openapi/ghe-2.15/operations/projects/remove-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/review-user-permission-level.json b/openapi/ghe-2.15/operations/projects/review-user-permission-level.json index 9cd67ba548..e7f9e35b8e 100644 --- a/openapi/ghe-2.15/operations/projects/review-user-permission-level.json +++ b/openapi/ghe-2.15/operations/projects/review-user-permission-level.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/projects/update-card.json b/openapi/ghe-2.15/operations/projects/update-card.json index 7ad8f9d3f8..1e632c36c8 100644 --- a/openapi/ghe-2.15/operations/projects/update-card.json +++ b/openapi/ghe-2.15/operations/projects/update-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,12 +58,12 @@ "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" + "type": "string", + "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`." }, "archived": { - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "type": "boolean" + "type": "boolean", + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card." } } } diff --git a/openapi/ghe-2.15/operations/projects/update-column.json b/openapi/ghe-2.15/operations/projects/update-column.json index 9cd62565ef..96a3d5c363 100644 --- a/openapi/ghe-2.15/operations/projects/update-column.json +++ b/openapi/ghe-2.15/operations/projects/update-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The new name of the column.", - "type": "string" + "type": "string", + "description": "The new name of the column." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/projects/update.json b/openapi/ghe-2.15/operations/projects/update.json index c5c923ba77..6e61d7c2af 100644 --- a/openapi/ghe-2.15/operations/projects/update.json +++ b/openapi/ghe-2.15/operations/projects/update.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,28 +180,28 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." }, "state": { - "description": "State of the project. Either `open` or `closed`.", "type": "string", + "description": "State of the project. Either `open` or `closed`.", "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.15/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.15/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" + "type": "string", + "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.15/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.15/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." }, "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" + "type": "boolean", + "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." } } } diff --git a/openapi/ghe-2.15/operations/pulls/check-if-merged.json b/openapi/ghe-2.15/operations/pulls/check-if-merged.json index 3db214db48..cdbdb29b8d 100644 --- a/openapi/ghe-2.15/operations/pulls/check-if-merged.json +++ b/openapi/ghe-2.15/operations/pulls/check-if-merged.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/create-comment-reply.json b/openapi/ghe-2.15/operations/pulls/create-comment-reply.json index 01d1336dea..2941304d6f 100644 --- a/openapi/ghe-2.15/operations/pulls/create-comment-reply.json +++ b/openapi/ghe-2.15/operations/pulls/create-comment-reply.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,12 +231,12 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/create-comment.json b/openapi/ghe-2.15/operations/pulls/create-comment.json index 87aabee629..f2fd51c8e8 100644 --- a/openapi/ghe-2.15/operations/pulls/create-comment.json +++ b/openapi/ghe-2.15/operations/pulls/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,20 +231,20 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "string", + "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`." }, "path": { - "description": "The relative path to the file that necessitates a comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/create-from-issue.json b/openapi/ghe-2.15/operations/pulls/create-from-issue.json index cf1bd3e2c9..9ff7f2f2b8 100644 --- a/openapi/ghe-2.15/operations/pulls/create-from-issue.json +++ b/openapi/ghe-2.15/operations/pulls/create-from-issue.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1502,20 +1502,20 @@ "type": "object", "properties": { "issue": { - "description": "The issue number in this repository to turn into a Pull Request.", - "type": "integer" + "type": "integer", + "description": "The issue number in this repository to turn into a Pull Request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/create-review-request.json b/openapi/ghe-2.15/operations/pulls/create-review-request.json index 6b5b14684d..5c1acf0547 100644 --- a/openapi/ghe-2.15/operations/pulls/create-review-request.json +++ b/openapi/ghe-2.15/operations/pulls/create-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1449,15 +1449,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be requested.", "type": "array", + "description": "An array of user `login`s that will be requested.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be requested.", "type": "array", + "description": "An array of team `slug`s that will be requested.", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/pulls/create-review.json b/openapi/ghe-2.15/operations/pulls/create-review.json index 2e17f75451..58179abab7 100644 --- a/openapi/ghe-2.15/operations/pulls/create-review.json +++ b/openapi/ghe-2.15/operations/pulls/create-review.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -196,16 +196,16 @@ "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" + "type": "string", + "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." }, "body": { - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "type": "string" + "type": "string", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." }, "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.15/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "type": "string", + "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.15/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -213,22 +213,22 @@ ] }, "comments": { - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "type": "array", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "items": { "type": "object", "properties": { "path": { - "description": "The relative path to the file that necessitates a review comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a review comment." }, "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" + "type": "integer", + "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." }, "body": { - "description": "Text of the review comment.", - "type": "string" + "type": "string", + "description": "Text of the review comment." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/create.json b/openapi/ghe-2.15/operations/pulls/create.json index 1976a6e4d9..102433a2f8 100644 --- a/openapi/ghe-2.15/operations/pulls/create.json +++ b/openapi/ghe-2.15/operations/pulls/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1502,24 +1502,24 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "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" + "type": "boolean", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/delete-comment.json b/openapi/ghe-2.15/operations/pulls/delete-comment.json index 7fbf55bd47..fc1deda24b 100644 --- a/openapi/ghe-2.15/operations/pulls/delete-comment.json +++ b/openapi/ghe-2.15/operations/pulls/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/delete-pending-review.json b/openapi/ghe-2.15/operations/pulls/delete-pending-review.json index 59222dce9b..11792e9431 100644 --- a/openapi/ghe-2.15/operations/pulls/delete-pending-review.json +++ b/openapi/ghe-2.15/operations/pulls/delete-pending-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/delete-review-request.json b/openapi/ghe-2.15/operations/pulls/delete-review-request.json index d2c329b201..ac5b3f4241 100644 --- a/openapi/ghe-2.15/operations/pulls/delete-review-request.json +++ b/openapi/ghe-2.15/operations/pulls/delete-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -85,15 +85,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be removed.", "type": "array", + "description": "An array of user `login`s that will be removed.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be removed.", "type": "array", + "description": "An array of team `slug`s that will be removed.", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/pulls/dismiss-review.json b/openapi/ghe-2.15/operations/pulls/dismiss-review.json index cebe170d40..304dc9ead4 100644 --- a/openapi/ghe-2.15/operations/pulls/dismiss-review.json +++ b/openapi/ghe-2.15/operations/pulls/dismiss-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,8 +204,8 @@ "type": "object", "properties": { "message": { - "description": "The message for the pull request review dismissal", - "type": "string" + "type": "string", + "description": "The message for the pull request review dismissal" } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/get-comment.json b/openapi/ghe-2.15/operations/pulls/get-comment.json index 7927889837..40ce5711ef 100644 --- a/openapi/ghe-2.15/operations/pulls/get-comment.json +++ b/openapi/ghe-2.15/operations/pulls/get-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/get-comments-for-review.json b/openapi/ghe-2.15/operations/pulls/get-comments-for-review.json index 148e6e927b..abb080dc9d 100644 --- a/openapi/ghe-2.15/operations/pulls/get-comments-for-review.json +++ b/openapi/ghe-2.15/operations/pulls/get-comments-for-review.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/get-review.json b/openapi/ghe-2.15/operations/pulls/get-review.json index 2d3951251f..c5af6f0728 100644 --- a/openapi/ghe-2.15/operations/pulls/get-review.json +++ b/openapi/ghe-2.15/operations/pulls/get-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/get.json b/openapi/ghe-2.15/operations/pulls/get.json index 7986b0a151..c46e4b5eb4 100644 --- a/openapi/ghe-2.15/operations/pulls/get.json +++ b/openapi/ghe-2.15/operations/pulls/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list-comments-for-repo.json b/openapi/ghe-2.15/operations/pulls/list-comments-for-repo.json index 7b65410180..5037d54f46 100644 --- a/openapi/ghe-2.15/operations/pulls/list-comments-for-repo.json +++ b/openapi/ghe-2.15/operations/pulls/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,51 +49,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list-comments.json b/openapi/ghe-2.15/operations/pulls/list-comments.json index 29348f5a3b..d4d591b005 100644 --- a/openapi/ghe-2.15/operations/pulls/list-comments.json +++ b/openapi/ghe-2.15/operations/pulls/list-comments.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,51 +58,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list-commits.json b/openapi/ghe-2.15/operations/pulls/list-commits.json index 879ddf031a..b909112db0 100644 --- a/openapi/ghe-2.15/operations/pulls/list-commits.json +++ b/openapi/ghe-2.15/operations/pulls/list-commits.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list-files.json b/openapi/ghe-2.15/operations/pulls/list-files.json index 03e3a0f6fa..9400f22d4a 100644 --- a/openapi/ghe-2.15/operations/pulls/list-files.json +++ b/openapi/ghe-2.15/operations/pulls/list-files.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list-review-requests.json b/openapi/ghe-2.15/operations/pulls/list-review-requests.json index 36efca22c5..408f039361 100644 --- a/openapi/ghe-2.15/operations/pulls/list-review-requests.json +++ b/openapi/ghe-2.15/operations/pulls/list-review-requests.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list-reviews.json b/openapi/ghe-2.15/operations/pulls/list-reviews.json index bd7ea735b1..c03c91a165 100644 --- a/openapi/ghe-2.15/operations/pulls/list-reviews.json +++ b/openapi/ghe-2.15/operations/pulls/list-reviews.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/list.json b/openapi/ghe-2.15/operations/pulls/list.json index 4fb1771771..359539045c 100644 --- a/openapi/ghe-2.15/operations/pulls/list.json +++ b/openapi/ghe-2.15/operations/pulls/list.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,31 +50,31 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Either `open`, `closed`, or `all` to filter by state." + } }, { "name": "head", + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", "in": "query", + "required": false, "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", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter pulls by base branch name. Example: `gh-pages`." + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -82,42 +84,38 @@ "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", + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/pulls/merge.json b/openapi/ghe-2.15/operations/pulls/merge.json index 84598e523b..d491d54b4b 100644 --- a/openapi/ghe-2.15/operations/pulls/merge.json +++ b/openapi/ghe-2.15/operations/pulls/merge.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -86,20 +86,20 @@ "type": "object", "properties": { "commit_title": { - "description": "Title for the automatic commit message.", - "type": "string" + "type": "string", + "description": "Title for the automatic commit message." }, "commit_message": { - "description": "Extra detail to append to automatic commit message.", - "type": "string" + "type": "string", + "description": "Extra detail to append to automatic commit message." }, "sha": { - "description": "SHA that pull request head must match to allow merge.", - "type": "string" + "type": "string", + "description": "SHA that pull request head must match to allow merge." }, "merge_method": { - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "type": "string", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "enum": [ "merge", "squash", diff --git a/openapi/ghe-2.15/operations/pulls/submit-review.json b/openapi/ghe-2.15/operations/pulls/submit-review.json index a1327e83ad..0dd6c010f5 100644 --- a/openapi/ghe-2.15/operations/pulls/submit-review.json +++ b/openapi/ghe-2.15/operations/pulls/submit-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,12 +204,12 @@ "type": "object", "properties": { "body": { - "description": "The body text of the pull request review", - "type": "string" + "type": "string", + "description": "The body text of the pull request review" }, "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", + "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.", "enum": [ "APPROVE", "REQUEST_CHANGES", diff --git a/openapi/ghe-2.15/operations/pulls/update-comment.json b/openapi/ghe-2.15/operations/pulls/update-comment.json index c961665297..4ed1fa2055 100644 --- a/openapi/ghe-2.15/operations/pulls/update-comment.json +++ b/openapi/ghe-2.15/operations/pulls/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -220,8 +220,8 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/pulls/update.json b/openapi/ghe-2.15/operations/pulls/update.json index e60e38740d..fe3de16621 100644 --- a/openapi/ghe-2.15/operations/pulls/update.json +++ b/openapi/ghe-2.15/operations/pulls/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1520,28 +1520,28 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", + "description": "State of this Pull Request. Either `open` or `closed`.", "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." } } } diff --git a/openapi/ghe-2.15/operations/reactions/create-for-commit-comment.json b/openapi/ghe-2.15/operations/reactions/create-for-commit-comment.json index 33c36823bf..ab49d59351 100644 --- a/openapi/ghe-2.15/operations/reactions/create-for-commit-comment.json +++ b/openapi/ghe-2.15/operations/reactions/create-for-commit-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the commit comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the commit comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.15/operations/reactions/create-for-issue-comment.json b/openapi/ghe-2.15/operations/reactions/create-for-issue-comment.json index c854a7ac94..faa5508231 100644 --- a/openapi/ghe-2.15/operations/reactions/create-for-issue-comment.json +++ b/openapi/ghe-2.15/operations/reactions/create-for-issue-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the issue comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the issue comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.15/operations/reactions/create-for-issue.json b/openapi/ghe-2.15/operations/reactions/create-for-issue.json index 711a0cdcdc..68173ac6e4 100644 --- a/openapi/ghe-2.15/operations/reactions/create-for-issue.json +++ b/openapi/ghe-2.15/operations/reactions/create-for-issue.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -166,8 +166,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the issue.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the issue.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.15/operations/reactions/create-for-pull-request-review-comment.json b/openapi/ghe-2.15/operations/reactions/create-for-pull-request-review-comment.json index 92169fbf16..50ec777fe9 100644 --- a/openapi/ghe-2.15/operations/reactions/create-for-pull-request-review-comment.json +++ b/openapi/ghe-2.15/operations/reactions/create-for-pull-request-review-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the pull request review comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the pull request review comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.15/operations/reactions/create-for-team-discussion-comment.json b/openapi/ghe-2.15/operations/reactions/create-for-team-discussion-comment.json index 955be303f5..cfe6a8ec88 100644 --- a/openapi/ghe-2.15/operations/reactions/create-for-team-discussion-comment.json +++ b/openapi/ghe-2.15/operations/reactions/create-for-team-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the team discussion comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the team discussion comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.15/operations/reactions/create-for-team-discussion.json b/openapi/ghe-2.15/operations/reactions/create-for-team-discussion.json index fd96bf1e89..ea7785a861 100644 --- a/openapi/ghe-2.15/operations/reactions/create-for-team-discussion.json +++ b/openapi/ghe-2.15/operations/reactions/create-for-team-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -147,8 +147,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the team discussion.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types) to add to the team discussion.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.15/operations/reactions/delete.json b/openapi/ghe-2.15/operations/reactions/delete.json index 305bac479c..c02d747a33 100644 --- a/openapi/ghe-2.15/operations/reactions/delete.json +++ b/openapi/ghe-2.15/operations/reactions/delete.json @@ -22,12 +22,12 @@ }, { "name": "reaction_id", + "description": "reaction_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "reaction_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/reactions/list-for-commit-comment.json b/openapi/ghe-2.15/operations/reactions/list-for-commit-comment.json index fca33a90f7..2f01745e18 100644 --- a/openapi/ghe-2.15/operations/reactions/list-for-commit-comment.json +++ b/openapi/ghe-2.15/operations/reactions/list-for-commit-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/reactions/list-for-issue-comment.json b/openapi/ghe-2.15/operations/reactions/list-for-issue-comment.json index 472ed23a54..e92652853a 100644 --- a/openapi/ghe-2.15/operations/reactions/list-for-issue-comment.json +++ b/openapi/ghe-2.15/operations/reactions/list-for-issue-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/reactions/list-for-issue.json b/openapi/ghe-2.15/operations/reactions/list-for-issue.json index 427ec38500..164acdfb48 100644 --- a/openapi/ghe-2.15/operations/reactions/list-for-issue.json +++ b/openapi/ghe-2.15/operations/reactions/list-for-issue.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/reactions/list-for-pull-request-review-comment.json b/openapi/ghe-2.15/operations/reactions/list-for-pull-request-review-comment.json index c46adcfb24..10e28c1657 100644 --- a/openapi/ghe-2.15/operations/reactions/list-for-pull-request-review-comment.json +++ b/openapi/ghe-2.15/operations/reactions/list-for-pull-request-review-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/reactions/list-for-team-discussion-comment.json b/openapi/ghe-2.15/operations/reactions/list-for-team-discussion-comment.json index 1cd90561f3..cf3b7efd73 100644 --- a/openapi/ghe-2.15/operations/reactions/list-for-team-discussion-comment.json +++ b/openapi/ghe-2.15/operations/reactions/list-for-team-discussion-comment.json @@ -22,34 +22,36 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/reactions/list-for-team-discussion.json b/openapi/ghe-2.15/operations/reactions/list-for-team-discussion.json index 84c59403d5..65954863f2 100644 --- a/openapi/ghe-2.15/operations/reactions/list-for-team-discussion.json +++ b/openapi/ghe-2.15/operations/reactions/list-for-team-discussion.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.15/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/accept-invitation.json b/openapi/ghe-2.15/operations/repos/accept-invitation.json index 7da68ae462..411664cc1e 100644 --- a/openapi/ghe-2.15/operations/repos/accept-invitation.json +++ b/openapi/ghe-2.15/operations/repos/accept-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/add-collaborator.json b/openapi/ghe-2.15/operations/repos/add-collaborator.json index 4b3706816c..ccd266eeb1 100644 --- a/openapi/ghe-2.15/operations/repos/add-collaborator.json +++ b/openapi/ghe-2.15/operations/repos/add-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -76,8 +76,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/ghe-2.15/operations/repos/add-deploy-key.json b/openapi/ghe-2.15/operations/repos/add-deploy-key.json index 193fb8b8ba..1e347d3ff1 100644 --- a/openapi/ghe-2.15/operations/repos/add-deploy-key.json +++ b/openapi/ghe-2.15/operations/repos/add-deploy-key.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "type": "object", "properties": { "title": { - "description": "A name for the key.", - "type": "string" + "type": "string", + "description": "A name for the key." }, "key": { - "description": "The contents of the key.", - "type": "string" + "type": "string", + "description": "The contents of the key." }, "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" + "type": "boolean", + "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/).\"" } }, "required": [ diff --git a/openapi/ghe-2.15/operations/repos/add-protected-branch-admin-enforcement.json b/openapi/ghe-2.15/operations/repos/add-protected-branch-admin-enforcement.json index 69d54acf87..6029dd06ed 100644 --- a/openapi/ghe-2.15/operations/repos/add-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.15/operations/repos/add-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/add-protected-branch-required-signatures.json b/openapi/ghe-2.15/operations/repos/add-protected-branch-required-signatures.json index e5f18a7812..c19963e7e2 100644 --- a/openapi/ghe-2.15/operations/repos/add-protected-branch-required-signatures.json +++ b/openapi/ghe-2.15/operations/repos/add-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/add-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.15/operations/repos/add-protected-branch-required-status-checks-contexts.json index c3a447a534..c2d1662083 100644 --- a/openapi/ghe-2.15/operations/repos/add-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.15/operations/repos/add-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/add-protected-branch-team-restrictions.json b/openapi/ghe-2.15/operations/repos/add-protected-branch-team-restrictions.json index 569ad85e42..0b19f7e3ee 100644 --- a/openapi/ghe-2.15/operations/repos/add-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/add-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/add-protected-branch-user-restrictions.json b/openapi/ghe-2.15/operations/repos/add-protected-branch-user-restrictions.json index d44d7a06ad..537bdbafdc 100644 --- a/openapi/ghe-2.15/operations/repos/add-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/add-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/check-collaborator.json b/openapi/ghe-2.15/operations/repos/check-collaborator.json index ff8cd9f555..1785435241 100644 --- a/openapi/ghe-2.15/operations/repos/check-collaborator.json +++ b/openapi/ghe-2.15/operations/repos/check-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/compare-commits.json b/openapi/ghe-2.15/operations/repos/compare-commits.json index ebf5ba8c2d..283b62dfdd 100644 --- a/openapi/ghe-2.15/operations/repos/compare-commits.json +++ b/openapi/ghe-2.15/operations/repos/compare-commits.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "base", + "description": "base parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "base parameter" + } }, { "name": "head", + "description": "head parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "head parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/create-commit-comment.json b/openapi/ghe-2.15/operations/repos/create-commit-comment.json index 89609b8f61..23a22b98fc 100644 --- a/openapi/ghe-2.15/operations/repos/create-commit-comment.json +++ b/openapi/ghe-2.15/operations/repos/create-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { @@ -187,20 +187,20 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." }, "path": { - "description": "Relative path of the file to comment on.", - "type": "string" + "type": "string", + "description": "Relative path of the file to comment on." }, "position": { - "description": "Line index in the diff to comment on.", - "type": "integer" + "type": "integer", + "description": "Line index in the diff to comment on." }, "line": { - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "type": "integer" + "type": "integer", + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/repos/create-deployment-status.json b/openapi/ghe-2.15/operations/repos/create-deployment-status.json index 4dec817390..1c123a7274 100644 --- a/openapi/ghe-2.15/operations/repos/create-deployment-status.json +++ b/openapi/ghe-2.15/operations/repos/create-deployment-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { @@ -179,8 +179,8 @@ "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.15/v3/previews/#enhanced-deployments) custom media type.", "type": "string", + "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.15/v3/previews/#enhanced-deployments) custom media type.", "enum": [ "error", "failure", @@ -190,28 +190,28 @@ ] }, "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", + "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": "" }, "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", + "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": "" }, "description": { - "description": "A short description of the status. The maximum description length is 140 characters.", "type": "string", + "description": "A short description of the status. The maximum description length is 140 characters.", "default": "" }, "environment_url": { - "description": "Sets the URL for accessing your environment.", "type": "string", + "description": "Sets the URL for accessing your environment.", "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", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/repos/create-deployment.json b/openapi/ghe-2.15/operations/repos/create-deployment.json index 71b2c1833e..9d707a52ae 100644 --- a/openapi/ghe-2.15/operations/repos/create-deployment.json +++ b/openapi/ghe-2.15/operations/repos/create-deployment.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,49 +66,49 @@ "type": "object", "properties": { "ref": { - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "type": "string" + "type": "string", + "description": "The ref to deploy. This can be a branch, tag, or SHA." }, "task": { - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "type": "string", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "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", + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", "default": true }, "required_contexts": { - "description": "The [status](https://developer.github.com/enterprise/2.15/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", + "description": "The [status](https://developer.github.com/enterprise/2.15/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.", "items": { "type": "string" } }, "payload": { - "description": "JSON payload with extra information about the deployment.", "type": "string", + "description": "JSON payload with extra information about the deployment.", "default": "" }, "environment": { - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "type": "string", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "default": "production" }, "description": { - "description": "Short description of the deployment.", "type": "string", + "description": "Short description of the deployment.", "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", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.", "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" + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/repos/create-for-authenticated-user.json b/openapi/ghe-2.15/operations/repos/create-for-authenticated-user.json index f3867dbfba..bff5dcc4da 100644 --- a/openapi/ghe-2.15/operations/repos/create-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/repos/create-for-authenticated-user.json @@ -355,67 +355,67 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/repos/create-fork.json b/openapi/ghe-2.15/operations/repos/create-fork.json index d2009c7f6b..b4b798681f 100644 --- a/openapi/ghe-2.15/operations/repos/create-fork.json +++ b/openapi/ghe-2.15/operations/repos/create-fork.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -373,8 +373,8 @@ "type": "object", "properties": { "organization": { - "description": "Optional parameter to specify the organization name if forking into an organization.", - "type": "string" + "type": "string", + "description": "Optional parameter to specify the organization name if forking into an organization." } } } diff --git a/openapi/ghe-2.15/operations/repos/create-hook.json b/openapi/ghe-2.15/operations/repos/create-hook.json index 22aaf0ea94..19b81e8ffc 100644 --- a/openapi/ghe-2.15/operations/repos/create-hook.json +++ b/openapi/ghe-2.15/operations/repos/create-hook.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -136,29 +136,29 @@ "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.15/v3/guides/replacing-github-services) for details.", "type": "string", + "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.15/v3/guides/replacing-github-services) for details.", "default": "web" }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.15/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.15/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -166,8 +166,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -176,8 +176,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/repos/create-in-org.json b/openapi/ghe-2.15/operations/repos/create-in-org.json index 3be04129f4..adf3540ae6 100644 --- a/openapi/ghe-2.15/operations/repos/create-in-org.json +++ b/openapi/ghe-2.15/operations/repos/create-in-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -364,67 +364,67 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/ghe-2.15/operations/repos/create-or-update-file.json b/openapi/ghe-2.15/operations/repos/create-or-update-file.json index d5a90339fa..e8d41b6ce4 100644 --- a/openapi/ghe-2.15/operations/repos/create-or-update-file.json +++ b/openapi/ghe-2.15/operations/repos/create-or-update-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -250,32 +250,32 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "content": { - "description": "The new file content, using Base64 encoding.", - "type": "string" + "type": "string", + "description": "The new file content, using Base64 encoding." }, "sha": { - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "The person that committed the file. Default: the authenticated user.", "type": "object", + "description": "The person that committed the file. Default: the authenticated user.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ @@ -284,16 +284,16 @@ ] }, "author": { - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "type": "object", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/repos/create-release.json b/openapi/ghe-2.15/operations/repos/create-release.json index 20aa924935..0c17e78564 100644 --- a/openapi/ghe-2.15/operations/repos/create-release.json +++ b/openapi/ghe-2.15/operations/repos/create-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -187,29 +187,29 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "type": "boolean", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "default": false }, "prerelease": { - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "type": "boolean", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "default": false } }, diff --git a/openapi/ghe-2.15/operations/repos/create-status.json b/openapi/ghe-2.15/operations/repos/create-status.json index 87dbb6c65b..22e80a16f1 100644 --- a/openapi/ghe-2.15/operations/repos/create-status.json +++ b/openapi/ghe-2.15/operations/repos/create-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { @@ -173,8 +173,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "enum": [ "error", "failure", @@ -183,16 +183,16 @@ ] }, "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" + "type": "string", + "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`" }, "description": { - "description": "A short description of the status.", - "type": "string" + "type": "string", + "description": "A short description of the status." }, "context": { - "description": "A string label to differentiate this status from the status of other systems.", "type": "string", + "description": "A string label to differentiate this status from the status of other systems.", "default": "default" } }, diff --git a/openapi/ghe-2.15/operations/repos/decline-invitation.json b/openapi/ghe-2.15/operations/repos/decline-invitation.json index 7976e2929e..feab00d3b4 100644 --- a/openapi/ghe-2.15/operations/repos/decline-invitation.json +++ b/openapi/ghe-2.15/operations/repos/decline-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete-commit-comment.json b/openapi/ghe-2.15/operations/repos/delete-commit-comment.json index d7f0b8865b..50d84deac2 100644 --- a/openapi/ghe-2.15/operations/repos/delete-commit-comment.json +++ b/openapi/ghe-2.15/operations/repos/delete-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete-download.json b/openapi/ghe-2.15/operations/repos/delete-download.json index 34da2f1894..712573e4a1 100644 --- a/openapi/ghe-2.15/operations/repos/delete-download.json +++ b/openapi/ghe-2.15/operations/repos/delete-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete-file.json b/openapi/ghe-2.15/operations/repos/delete-file.json index 07bbb8606b..e0b9d59208 100644 --- a/openapi/ghe-2.15/operations/repos/delete-file.json +++ b/openapi/ghe-2.15/operations/repos/delete-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -180,42 +180,42 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "sha": { - "description": "The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "object containing information about the committer.", "type": "object", + "description": "object containing information about the committer.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } }, "author": { - "description": "object containing information about the author.", "type": "object", + "description": "object containing information about the author.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } } diff --git a/openapi/ghe-2.15/operations/repos/delete-hook.json b/openapi/ghe-2.15/operations/repos/delete-hook.json index 5600862173..146ff11769 100644 --- a/openapi/ghe-2.15/operations/repos/delete-hook.json +++ b/openapi/ghe-2.15/operations/repos/delete-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete-invitation.json b/openapi/ghe-2.15/operations/repos/delete-invitation.json index c17be0b83e..af8da9cc07 100644 --- a/openapi/ghe-2.15/operations/repos/delete-invitation.json +++ b/openapi/ghe-2.15/operations/repos/delete-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete-release-asset.json b/openapi/ghe-2.15/operations/repos/delete-release-asset.json index bb6d145ddd..b7bc0715f6 100644 --- a/openapi/ghe-2.15/operations/repos/delete-release-asset.json +++ b/openapi/ghe-2.15/operations/repos/delete-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete-release.json b/openapi/ghe-2.15/operations/repos/delete-release.json index 6dba021e33..bce859441e 100644 --- a/openapi/ghe-2.15/operations/repos/delete-release.json +++ b/openapi/ghe-2.15/operations/repos/delete-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/delete.json b/openapi/ghe-2.15/operations/repos/delete.json index 980690f363..7056a58302 100644 --- a/openapi/ghe-2.15/operations/repos/delete.json +++ b/openapi/ghe-2.15/operations/repos/delete.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-archive-link.json b/openapi/ghe-2.15/operations/repos/get-archive-link.json index 4d55a9d54e..c8829a94d2 100644 --- a/openapi/ghe-2.15/operations/repos/get-archive-link.json +++ b/openapi/ghe-2.15/operations/repos/get-archive-link.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "archive_format", + "description": "archive_format parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "archive_format parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-branch-protection.json b/openapi/ghe-2.15/operations/repos/get-branch-protection.json index bd5d2c2932..98a0e22205 100644 --- a/openapi/ghe-2.15/operations/repos/get-branch-protection.json +++ b/openapi/ghe-2.15/operations/repos/get-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-branch.json b/openapi/ghe-2.15/operations/repos/get-branch.json index 5b5f30153e..57672d386b 100644 --- a/openapi/ghe-2.15/operations/repos/get-branch.json +++ b/openapi/ghe-2.15/operations/repos/get-branch.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-code-frequency-stats.json b/openapi/ghe-2.15/operations/repos/get-code-frequency-stats.json index e725922aca..826f297d69 100644 --- a/openapi/ghe-2.15/operations/repos/get-code-frequency-stats.json +++ b/openapi/ghe-2.15/operations/repos/get-code-frequency-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-collaborator-permission-level.json b/openapi/ghe-2.15/operations/repos/get-collaborator-permission-level.json index e0473796ef..871e3f5faf 100644 --- a/openapi/ghe-2.15/operations/repos/get-collaborator-permission-level.json +++ b/openapi/ghe-2.15/operations/repos/get-collaborator-permission-level.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-combined-status-for-ref.json b/openapi/ghe-2.15/operations/repos/get-combined-status-for-ref.json index 987c45e085..c95ac74dc3 100644 --- a/openapi/ghe-2.15/operations/repos/get-combined-status-for-ref.json +++ b/openapi/ghe-2.15/operations/repos/get-combined-status-for-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-commit-activity-stats.json b/openapi/ghe-2.15/operations/repos/get-commit-activity-stats.json index 79dcd7792c..43b94568e8 100644 --- a/openapi/ghe-2.15/operations/repos/get-commit-activity-stats.json +++ b/openapi/ghe-2.15/operations/repos/get-commit-activity-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-commit-comment.json b/openapi/ghe-2.15/operations/repos/get-commit-comment.json index 57e6c51cce..9791de7033 100644 --- a/openapi/ghe-2.15/operations/repos/get-commit-comment.json +++ b/openapi/ghe-2.15/operations/repos/get-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-commit.json b/openapi/ghe-2.15/operations/repos/get-commit.json index d2a9d31784..5f13861ac6 100644 --- a/openapi/ghe-2.15/operations/repos/get-commit.json +++ b/openapi/ghe-2.15/operations/repos/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-contents.json b/openapi/ghe-2.15/operations/repos/get-contents.json index 9ac464c8dd..fdf3aff906 100644 --- a/openapi/ghe-2.15/operations/repos/get-contents.json +++ b/openapi/ghe-2.15/operations/repos/get-contents.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-contributors-stats.json b/openapi/ghe-2.15/operations/repos/get-contributors-stats.json index 34427f6ffd..0f31c9b7f4 100644 --- a/openapi/ghe-2.15/operations/repos/get-contributors-stats.json +++ b/openapi/ghe-2.15/operations/repos/get-contributors-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-deploy-key.json b/openapi/ghe-2.15/operations/repos/get-deploy-key.json index fdf1f475e0..160c807c9e 100644 --- a/openapi/ghe-2.15/operations/repos/get-deploy-key.json +++ b/openapi/ghe-2.15/operations/repos/get-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-deployment-status.json b/openapi/ghe-2.15/operations/repos/get-deployment-status.json index a8380cd2a7..e5a98e3c41 100644 --- a/openapi/ghe-2.15/operations/repos/get-deployment-status.json +++ b/openapi/ghe-2.15/operations/repos/get-deployment-status.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "status_id", + "description": "status_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "status_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-deployment.json b/openapi/ghe-2.15/operations/repos/get-deployment.json index 3884d95568..606f287186 100644 --- a/openapi/ghe-2.15/operations/repos/get-deployment.json +++ b/openapi/ghe-2.15/operations/repos/get-deployment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-download.json b/openapi/ghe-2.15/operations/repos/get-download.json index 9e0ebbfdb6..843c0e3b74 100644 --- a/openapi/ghe-2.15/operations/repos/get-download.json +++ b/openapi/ghe-2.15/operations/repos/get-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-hook.json b/openapi/ghe-2.15/operations/repos/get-hook.json index a6131ad422..b5d4f48277 100644 --- a/openapi/ghe-2.15/operations/repos/get-hook.json +++ b/openapi/ghe-2.15/operations/repos/get-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-latest-pages-build.json b/openapi/ghe-2.15/operations/repos/get-latest-pages-build.json index 449db7b63f..094fae17e4 100644 --- a/openapi/ghe-2.15/operations/repos/get-latest-pages-build.json +++ b/openapi/ghe-2.15/operations/repos/get-latest-pages-build.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-latest-release.json b/openapi/ghe-2.15/operations/repos/get-latest-release.json index f807cc1165..4eaa9a3946 100644 --- a/openapi/ghe-2.15/operations/repos/get-latest-release.json +++ b/openapi/ghe-2.15/operations/repos/get-latest-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-pages-build.json b/openapi/ghe-2.15/operations/repos/get-pages-build.json index 2e2f26c673..d14be8b7b6 100644 --- a/openapi/ghe-2.15/operations/repos/get-pages-build.json +++ b/openapi/ghe-2.15/operations/repos/get-pages-build.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "build_id", + "description": "build_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "build_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-pages.json b/openapi/ghe-2.15/operations/repos/get-pages.json index 6d2100af4a..a5b3cd6b90 100644 --- a/openapi/ghe-2.15/operations/repos/get-pages.json +++ b/openapi/ghe-2.15/operations/repos/get-pages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-participation-stats.json b/openapi/ghe-2.15/operations/repos/get-participation-stats.json index 3beae165ea..2b785cabdf 100644 --- a/openapi/ghe-2.15/operations/repos/get-participation-stats.json +++ b/openapi/ghe-2.15/operations/repos/get-participation-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-protected-branch-admin-enforcement.json b/openapi/ghe-2.15/operations/repos/get-protected-branch-admin-enforcement.json index eeb1039bb4..b5f135c196 100644 --- a/openapi/ghe-2.15/operations/repos/get-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.15/operations/repos/get-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.15/operations/repos/get-protected-branch-pull-request-review-enforcement.json index 39dd5c001a..1e71b83045 100644 --- a/openapi/ghe-2.15/operations/repos/get-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.15/operations/repos/get-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-protected-branch-required-signatures.json b/openapi/ghe-2.15/operations/repos/get-protected-branch-required-signatures.json index 5172076137..ea21150a0e 100644 --- a/openapi/ghe-2.15/operations/repos/get-protected-branch-required-signatures.json +++ b/openapi/ghe-2.15/operations/repos/get-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-protected-branch-required-status-checks.json b/openapi/ghe-2.15/operations/repos/get-protected-branch-required-status-checks.json index c424dfc1c6..92af29f8ad 100644 --- a/openapi/ghe-2.15/operations/repos/get-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.15/operations/repos/get-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-protected-branch-restrictions.json b/openapi/ghe-2.15/operations/repos/get-protected-branch-restrictions.json index 4e8e7f0594..00dc5c67d2 100644 --- a/openapi/ghe-2.15/operations/repos/get-protected-branch-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/get-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-punch-card-stats.json b/openapi/ghe-2.15/operations/repos/get-punch-card-stats.json index 764c39e50c..6ce0f7999d 100644 --- a/openapi/ghe-2.15/operations/repos/get-punch-card-stats.json +++ b/openapi/ghe-2.15/operations/repos/get-punch-card-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-readme.json b/openapi/ghe-2.15/operations/repos/get-readme.json index b5a00c02eb..50fb7c7507 100644 --- a/openapi/ghe-2.15/operations/repos/get-readme.json +++ b/openapi/ghe-2.15/operations/repos/get-readme.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-release-asset.json b/openapi/ghe-2.15/operations/repos/get-release-asset.json index 6ca4d8613c..87219f9bc2 100644 --- a/openapi/ghe-2.15/operations/repos/get-release-asset.json +++ b/openapi/ghe-2.15/operations/repos/get-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-release-by-tag.json b/openapi/ghe-2.15/operations/repos/get-release-by-tag.json index ceda060d08..3945612604 100644 --- a/openapi/ghe-2.15/operations/repos/get-release-by-tag.json +++ b/openapi/ghe-2.15/operations/repos/get-release-by-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag", + "description": "tag parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get-release.json b/openapi/ghe-2.15/operations/repos/get-release.json index a3fc1aebcb..8a24541419 100644 --- a/openapi/ghe-2.15/operations/repos/get-release.json +++ b/openapi/ghe-2.15/operations/repos/get-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/get.json b/openapi/ghe-2.15/operations/repos/get.json index 6dd3ee2f09..06a7c501a3 100644 --- a/openapi/ghe-2.15/operations/repos/get.json +++ b/openapi/ghe-2.15/operations/repos/get.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-assets-for-release.json b/openapi/ghe-2.15/operations/repos/list-assets-for-release.json index f40ad12dab..f291963f75 100644 --- a/openapi/ghe-2.15/operations/repos/list-assets-for-release.json +++ b/openapi/ghe-2.15/operations/repos/list-assets-for-release.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-branches.json b/openapi/ghe-2.15/operations/repos/list-branches.json index 39c9268704..b2923ff2d2 100644 --- a/openapi/ghe-2.15/operations/repos/list-branches.json +++ b/openapi/ghe-2.15/operations/repos/list-branches.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "protected", + "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.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-collaborators.json b/openapi/ghe-2.15/operations/repos/list-collaborators.json index fee3c7095a..738bfb18f2 100644 --- a/openapi/ghe-2.15/operations/repos/list-collaborators.json +++ b/openapi/ghe-2.15/operations/repos/list-collaborators.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-comments-for-commit.json b/openapi/ghe-2.15/operations/repos/list-comments-for-commit.json index 50729ab432..91ece02836 100644 --- a/openapi/ghe-2.15/operations/repos/list-comments-for-commit.json +++ b/openapi/ghe-2.15/operations/repos/list-comments-for-commit.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-commit-comments.json b/openapi/ghe-2.15/operations/repos/list-commit-comments.json index 1663261c34..a14924ffeb 100644 --- a/openapi/ghe-2.15/operations/repos/list-commit-comments.json +++ b/openapi/ghe-2.15/operations/repos/list-commit-comments.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-commits.json b/openapi/ghe-2.15/operations/repos/list-commits.json index b42016a840..aa0706d631 100644 --- a/openapi/ghe-2.15/operations/repos/list-commits.json +++ b/openapi/ghe-2.15/operations/repos/list-commits.json @@ -21,86 +21,84 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`)." + } }, { "name": "path", + "description": "Only commits containing this file path will be returned.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Only commits containing this file path will be returned." + } }, { "name": "author", + "description": "GitHub login or email address by which to filter by commit author.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "GitHub login or email address by which to filter by commit author." + } }, { "name": "since", + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-contributors.json b/openapi/ghe-2.15/operations/repos/list-contributors.json index cf1b20ccd2..f402fa4796 100644 --- a/openapi/ghe-2.15/operations/repos/list-contributors.json +++ b/openapi/ghe-2.15/operations/repos/list-contributors.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Set to `1` or `true` to include anonymous contributors in results." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-deploy-keys.json b/openapi/ghe-2.15/operations/repos/list-deploy-keys.json index 8ec1f93cf7..e08b6199e1 100644 --- a/openapi/ghe-2.15/operations/repos/list-deploy-keys.json +++ b/openapi/ghe-2.15/operations/repos/list-deploy-keys.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-deployment-statuses.json b/openapi/ghe-2.15/operations/repos/list-deployment-statuses.json index 5d59a1c592..4e93fbb843 100644 --- a/openapi/ghe-2.15/operations/repos/list-deployment-statuses.json +++ b/openapi/ghe-2.15/operations/repos/list-deployment-statuses.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-deployments.json b/openapi/ghe-2.15/operations/repos/list-deployments.json index 29dba903c2..4f65c2708a 100644 --- a/openapi/ghe-2.15/operations/repos/list-deployments.json +++ b/openapi/ghe-2.15/operations/repos/list-deployments.json @@ -21,81 +21,79 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "The SHA recorded at creation time.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The SHA recorded at creation time." + } }, { "name": "ref", + "description": "The name of the ref. This can be a branch, tag, or SHA.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the ref. This can be a branch, tag, or SHA." + } }, { "name": "task", + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`)." + } }, { "name": "environment", + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-downloads.json b/openapi/ghe-2.15/operations/repos/list-downloads.json index 15594e6767..bc3148475a 100644 --- a/openapi/ghe-2.15/operations/repos/list-downloads.json +++ b/openapi/ghe-2.15/operations/repos/list-downloads.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-for-org.json b/openapi/ghe-2.15/operations/repos/list-for-org.json index 611a0d54de..7551445d65 100644 --- a/openapi/ghe-2.15/operations/repos/list-for-org.json +++ b/openapi/ghe-2.15/operations/repos/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -42,29 +44,25 @@ "member" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-for-user.json b/openapi/ghe-2.15/operations/repos/list-for-user.json index 177126902a..7bfcfbdc9c 100644 --- a/openapi/ghe-2.15/operations/repos/list-for-user.json +++ b/openapi/ghe-2.15/operations/repos/list-for-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `owner`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "member" ], "default": "owner" - }, - "required": false, - "description": "Can be one of `all`, `owner`, `member`." + } }, { "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -55,42 +57,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-forks.json b/openapi/ghe-2.15/operations/repos/list-forks.json index 5f0c1719fb..c65dd34c02 100644 --- a/openapi/ghe-2.15/operations/repos/list-forks.json +++ b/openapi/ghe-2.15/operations/repos/list-forks.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "stargazers" ], "default": "newest" - }, - "required": false, - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-hooks.json b/openapi/ghe-2.15/operations/repos/list-hooks.json index 6a70895ef1..b18220c961 100644 --- a/openapi/ghe-2.15/operations/repos/list-hooks.json +++ b/openapi/ghe-2.15/operations/repos/list-hooks.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-invitations-for-authenticated-user.json b/openapi/ghe-2.15/operations/repos/list-invitations-for-authenticated-user.json index bff6588d3a..5c7bbfcab4 100644 --- a/openapi/ghe-2.15/operations/repos/list-invitations-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/repos/list-invitations-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-invitations.json b/openapi/ghe-2.15/operations/repos/list-invitations.json index a14a8855ca..1bb1262395 100644 --- a/openapi/ghe-2.15/operations/repos/list-invitations.json +++ b/openapi/ghe-2.15/operations/repos/list-invitations.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-languages.json b/openapi/ghe-2.15/operations/repos/list-languages.json index 949f53ee34..1365d2e8de 100644 --- a/openapi/ghe-2.15/operations/repos/list-languages.json +++ b/openapi/ghe-2.15/operations/repos/list-languages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-pages-builds.json b/openapi/ghe-2.15/operations/repos/list-pages-builds.json index aa451f1304..d33ffbe3c9 100644 --- a/openapi/ghe-2.15/operations/repos/list-pages-builds.json +++ b/openapi/ghe-2.15/operations/repos/list-pages-builds.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.15/operations/repos/list-protected-branch-required-status-checks-contexts.json index 602e30fa6c..83edaa45a7 100644 --- a/openapi/ghe-2.15/operations/repos/list-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.15/operations/repos/list-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-protected-branch-team-restrictions.json b/openapi/ghe-2.15/operations/repos/list-protected-branch-team-restrictions.json index 177f655bd8..eb1fa077c3 100644 --- a/openapi/ghe-2.15/operations/repos/list-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/list-protected-branch-team-restrictions.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-protected-branch-user-restrictions.json b/openapi/ghe-2.15/operations/repos/list-protected-branch-user-restrictions.json index 3b76771052..cbcd001795 100644 --- a/openapi/ghe-2.15/operations/repos/list-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/list-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-public.json b/openapi/ghe-2.15/operations/repos/list-public.json index 9ad316c3c4..90a5bc3abd 100644 --- a/openapi/ghe-2.15/operations/repos/list-public.json +++ b/openapi/ghe-2.15/operations/repos/list-public.json @@ -21,42 +21,40 @@ }, { "name": "since", + "description": "The integer ID of the last Repository that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Repository that you've seen." + } }, { "name": "visibility", + "description": "To include private repositories as well set to `all`.", "in": "query", + "required": false, "schema": { "type": "string", "default": "public" - }, - "required": false, - "description": "To include private repositories as well set to `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-releases.json b/openapi/ghe-2.15/operations/repos/list-releases.json index 0854f1a4a1..dfad4ef613 100644 --- a/openapi/ghe-2.15/operations/repos/list-releases.json +++ b/openapi/ghe-2.15/operations/repos/list-releases.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-statuses-for-ref.json b/openapi/ghe-2.15/operations/repos/list-statuses-for-ref.json index 3a6cc91ff6..b564f6f386 100644 --- a/openapi/ghe-2.15/operations/repos/list-statuses-for-ref.json +++ b/openapi/ghe-2.15/operations/repos/list-statuses-for-ref.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-tags.json b/openapi/ghe-2.15/operations/repos/list-tags.json index 9e9dab57da..ddd11a2b5a 100644 --- a/openapi/ghe-2.15/operations/repos/list-tags.json +++ b/openapi/ghe-2.15/operations/repos/list-tags.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-teams.json b/openapi/ghe-2.15/operations/repos/list-teams.json index 7b0eb439ea..e1019423da 100644 --- a/openapi/ghe-2.15/operations/repos/list-teams.json +++ b/openapi/ghe-2.15/operations/repos/list-teams.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list-topics.json b/openapi/ghe-2.15/operations/repos/list-topics.json index d63c8d55e9..1555ccf076 100644 --- a/openapi/ghe-2.15/operations/repos/list-topics.json +++ b/openapi/ghe-2.15/operations/repos/list-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/list.json b/openapi/ghe-2.15/operations/repos/list.json index 998fbf5f8b..c34d146368 100644 --- a/openapi/ghe-2.15/operations/repos/list.json +++ b/openapi/ghe-2.15/operations/repos/list.json @@ -21,7 +21,9 @@ }, { "name": "visibility", + "description": "Can be one of `all`, `public`, or `private`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -30,23 +32,23 @@ "private" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, or `private`." + } }, { "name": "affiliation", + "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.", "in": "query", + "required": false, "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", + "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**.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,13 +59,13 @@ "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", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -73,42 +75,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/merge.json b/openapi/ghe-2.15/operations/repos/merge.json index c44b017b12..618195ffe3 100644 --- a/openapi/ghe-2.15/operations/repos/merge.json +++ b/openapi/ghe-2.15/operations/repos/merge.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,16 +66,16 @@ "type": "object", "properties": { "base": { - "description": "The name of the base branch that the head will be merged into.", - "type": "string" + "type": "string", + "description": "The name of the base branch that the head will be merged into." }, "head": { - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "type": "string" + "type": "string", + "description": "The head to merge. This can be a branch name or a commit SHA1." }, "commit_message": { - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "type": "string" + "type": "string", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/repos/ping-hook.json b/openapi/ghe-2.15/operations/repos/ping-hook.json index f91ddac347..028dbe69c7 100644 --- a/openapi/ghe-2.15/operations/repos/ping-hook.json +++ b/openapi/ghe-2.15/operations/repos/ping-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-branch-protection.json b/openapi/ghe-2.15/operations/repos/remove-branch-protection.json index d3ed62054a..629df66411 100644 --- a/openapi/ghe-2.15/operations/repos/remove-branch-protection.json +++ b/openapi/ghe-2.15/operations/repos/remove-branch-protection.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-collaborator.json b/openapi/ghe-2.15/operations/repos/remove-collaborator.json index 07e4577c49..1e8ba73b95 100644 --- a/openapi/ghe-2.15/operations/repos/remove-collaborator.json +++ b/openapi/ghe-2.15/operations/repos/remove-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-deploy-key.json b/openapi/ghe-2.15/operations/repos/remove-deploy-key.json index bd286aa688..30253a9ae3 100644 --- a/openapi/ghe-2.15/operations/repos/remove-deploy-key.json +++ b/openapi/ghe-2.15/operations/repos/remove-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-admin-enforcement.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-admin-enforcement.json index 5720c732e6..7530d52089 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-pull-request-review-enforcement.json index 1e84184cfa..09053ebbe8 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-pull-request-review-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-signatures.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-signatures.json index 9ebe938981..8b6ed078a8 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-signatures.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks-contexts.json index f5d585168d..a4e1d84b94 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks.json index 89c82b0c2f..23406d2270 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-restrictions.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-restrictions.json index e2cda5795a..505f6968be 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-team-restrictions.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-team-restrictions.json index 7c3e6947c7..3383509c5e 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/remove-protected-branch-user-restrictions.json b/openapi/ghe-2.15/operations/repos/remove-protected-branch-user-restrictions.json index f9668bf820..b778b75854 100644 --- a/openapi/ghe-2.15/operations/repos/remove-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/remove-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/replace-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.15/operations/repos/replace-protected-branch-required-status-checks-contexts.json index 45b9372b64..5c376b9794 100644 --- a/openapi/ghe-2.15/operations/repos/replace-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.15/operations/repos/replace-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/replace-protected-branch-team-restrictions.json b/openapi/ghe-2.15/operations/repos/replace-protected-branch-team-restrictions.json index 77fbe36800..cebc4c3f85 100644 --- a/openapi/ghe-2.15/operations/repos/replace-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/replace-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/replace-protected-branch-user-restrictions.json b/openapi/ghe-2.15/operations/repos/replace-protected-branch-user-restrictions.json index 7a3e7e38b9..b3b850c73d 100644 --- a/openapi/ghe-2.15/operations/repos/replace-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.15/operations/repos/replace-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.15/operations/repos/replace-topics.json b/openapi/ghe-2.15/operations/repos/replace-topics.json index 4ef5148d99..7de3acfd67 100644 --- a/openapi/ghe-2.15/operations/repos/replace-topics.json +++ b/openapi/ghe-2.15/operations/repos/replace-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,8 +81,8 @@ "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", + "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.", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/repos/request-page-build.json b/openapi/ghe-2.15/operations/repos/request-page-build.json index 42db42f872..a76b44e02d 100644 --- a/openapi/ghe-2.15/operations/repos/request-page-build.json +++ b/openapi/ghe-2.15/operations/repos/request-page-build.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/test-push-hook.json b/openapi/ghe-2.15/operations/repos/test-push-hook.json index 4ef73e699b..1dfef0cf51 100644 --- a/openapi/ghe-2.15/operations/repos/test-push-hook.json +++ b/openapi/ghe-2.15/operations/repos/test-push-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/repos/transfer.json b/openapi/ghe-2.15/operations/repos/transfer.json index 6cfd4a3030..3f81954f8e 100644 --- a/openapi/ghe-2.15/operations/repos/transfer.json +++ b/openapi/ghe-2.15/operations/repos/transfer.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -374,12 +374,12 @@ "type": "object", "properties": { "new_owner": { - "description": "**Required:** The username or organization name the repository will be transferred to.", - "type": "string" + "type": "string", + "description": "**Required:** The username or organization name the repository will be transferred to." }, "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", + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", "items": { "type": "integer" } diff --git a/openapi/ghe-2.15/operations/repos/update-branch-protection.json b/openapi/ghe-2.15/operations/repos/update-branch-protection.json index 64c9557c85..cc2ca193a6 100644 --- a/openapi/ghe-2.15/operations/repos/update-branch-protection.json +++ b/openapi/ghe-2.15/operations/repos/update-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -370,17 +370,17 @@ "type": "object", "properties": { "required_status_checks": { - "description": "Require status checks to pass before merging. Set to `null` to disable.", "type": "object", + "description": "Require status checks to pass before merging. Set to `null` to disable.", "nullable": true, "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } @@ -392,29 +392,29 @@ ] }, "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", + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", "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", + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -422,34 +422,34 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them." }, "required_approving_review_count": { - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } }, "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", + "description": "Restrict who can push to this branch. Team and user `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "nullable": true, "properties": { "users": { - "description": "The list of user `login`s with push access", "type": "array", + "description": "The list of user `login`s with push access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with push access", "type": "array", + "description": "The list of team `slug`s with push access", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/repos/update-commit-comment.json b/openapi/ghe-2.15/operations/repos/update-commit-comment.json index e7a9d0635b..2a479a0df5 100644 --- a/openapi/ghe-2.15/operations/repos/update-commit-comment.json +++ b/openapi/ghe-2.15/operations/repos/update-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -176,8 +176,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment", - "type": "string" + "type": "string", + "description": "The contents of the comment" } }, "required": [ diff --git a/openapi/ghe-2.15/operations/repos/update-hook.json b/openapi/ghe-2.15/operations/repos/update-hook.json index 1b3cbe0ad2..aa5ec7d54e 100644 --- a/openapi/ghe-2.15/operations/repos/update-hook.json +++ b/openapi/ghe-2.15/operations/repos/update-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -145,24 +145,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.15/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.15/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.15/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -170,8 +170,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.15/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -180,22 +180,22 @@ } }, "add_events": { - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "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", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.15/operations/repos/update-information-about-pages-site.json b/openapi/ghe-2.15/operations/repos/update-information-about-pages-site.json index 10ccb25dbe..c4672f9320 100644 --- a/openapi/ghe-2.15/operations/repos/update-information-about-pages-site.json +++ b/openapi/ghe-2.15/operations/repos/update-information-about-pages-site.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "type": "object", "properties": { "source": { - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "type": "string", + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "enum": [ "\"gh-pages\"", "\"master\"", diff --git a/openapi/ghe-2.15/operations/repos/update-invitation.json b/openapi/ghe-2.15/operations/repos/update-invitation.json index f38fb6d39a..0cecbf9af8 100644 --- a/openapi/ghe-2.15/operations/repos/update-invitation.json +++ b/openapi/ghe-2.15/operations/repos/update-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { @@ -419,8 +419,8 @@ "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", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.15/operations/repos/update-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.15/operations/repos/update-protected-branch-pull-request-review-enforcement.json index abe690482c..07fb5bbdd8 100644 --- a/openapi/ghe-2.15/operations/repos/update-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.15/operations/repos/update-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -214,19 +214,19 @@ "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -234,16 +234,16 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } } diff --git a/openapi/ghe-2.15/operations/repos/update-protected-branch-required-status-checks.json b/openapi/ghe-2.15/operations/repos/update-protected-branch-required-status-checks.json index 66b8d3fad2..445b95cbeb 100644 --- a/openapi/ghe-2.15/operations/repos/update-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.15/operations/repos/update-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -99,12 +99,12 @@ "type": "object", "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/repos/update-release-asset.json b/openapi/ghe-2.15/operations/repos/update-release-asset.json index b0a35df929..92a9c81437 100644 --- a/openapi/ghe-2.15/operations/repos/update-release-asset.json +++ b/openapi/ghe-2.15/operations/repos/update-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "name": { - "description": "The file name of the asset.", - "type": "string" + "type": "string", + "description": "The file name of the asset." }, "label": { - "description": "An alternate short description of the asset. Used in place of the filename.", - "type": "string" + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename." } } } diff --git a/openapi/ghe-2.15/operations/repos/update-release.json b/openapi/ghe-2.15/operations/repos/update-release.json index 4b9ed2dc64..5554154cf1 100644 --- a/openapi/ghe-2.15/operations/repos/update-release.json +++ b/openapi/ghe-2.15/operations/repos/update-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { @@ -294,28 +294,28 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` makes the release a draft, and `false` publishes the release.", - "type": "boolean" + "type": "boolean", + "description": "`true` makes the release a draft, and `false` publishes the release." }, "prerelease": { - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "type": "boolean" + "type": "boolean", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release." } } } diff --git a/openapi/ghe-2.15/operations/repos/update.json b/openapi/ghe-2.15/operations/repos/update.json index 9813fcc91d..d37d8a9423 100644 --- a/openapi/ghe-2.15/operations/repos/update.json +++ b/openapi/ghe-2.15/operations/repos/update.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1036,64 +1036,64 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "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.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "default": true }, "default_branch": { - "description": "Updates the default branch for this repository.", - "type": "string" + "type": "string", + "description": "Updates the default branch for this repository." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true }, "archived": { - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "type": "boolean", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.15/operations/search/code.json b/openapi/ghe-2.15/operations/search/code.json index ccdae482de..96b5289d2b 100644 --- a/openapi/ghe-2.15/operations/search/code.json +++ b/openapi/ghe-2.15/operations/search/code.json @@ -21,28 +21,30 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.15/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.15/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.15/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -50,29 +52,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/commits.json b/openapi/ghe-2.15/operations/search/commits.json index 51a7d9d58e..bf7f3d3452 100644 --- a/openapi/ghe-2.15/operations/search/commits.json +++ b/openapi/ghe-2.15/operations/search/commits.json @@ -22,29 +22,31 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.15/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.15/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.15/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/email-legacy.json b/openapi/ghe-2.15/operations/search/email-legacy.json index 31d4a286a6..07e803e163 100644 --- a/openapi/ghe-2.15/operations/search/email-legacy.json +++ b/openapi/ghe-2.15/operations/search/email-legacy.json @@ -21,12 +21,12 @@ }, { "name": "email", + "description": "The email address.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The email address." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/issues-and-pull-requests.json b/openapi/ghe-2.15/operations/search/issues-and-pull-requests.json index 7355af1dfd..95695bab64 100644 --- a/openapi/ghe-2.15/operations/search/issues-and-pull-requests.json +++ b/openapi/ghe-2.15/operations/search/issues-and-pull-requests.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.15/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", + "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.15/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -46,13 +48,13 @@ "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.15/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,29 +62,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/issues-legacy.json b/openapi/ghe-2.15/operations/search/issues-legacy.json index a24b60b5e9..cc5bfccda7 100644 --- a/openapi/ghe-2.15/operations/search/issues-legacy.json +++ b/openapi/ghe-2.15/operations/search/issues-legacy.json @@ -21,43 +21,43 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repository", + "description": "repository parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repository parameter" + } }, { "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", "in": "path", + "required": true, "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", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/labels.json b/openapi/ghe-2.15/operations/search/labels.json index e6c3e28856..85cb2b5c62 100644 --- a/openapi/ghe-2.15/operations/search/labels.json +++ b/openapi/ghe-2.15/operations/search/labels.json @@ -21,38 +21,40 @@ }, { "name": "repository_id", + "description": "The id of the repository.", "in": "query", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "The id of the repository." + } }, { "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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.15/v3/search/#constructing-a-search-query)." + } }, { "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.15/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.15/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,9 +62,7 @@ "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": { diff --git a/openapi/ghe-2.15/operations/search/repos-legacy.json b/openapi/ghe-2.15/operations/search/repos-legacy.json index 42ae7074dd..fbdd958860 100644 --- a/openapi/ghe-2.15/operations/search/repos-legacy.json +++ b/openapi/ghe-2.15/operations/search/repos-legacy.json @@ -21,34 +21,36 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "language", + "description": "Filter results by language.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter results by language." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/repos.json b/openapi/ghe-2.15/operations/search/repos.json index c22436fafa..0801dcd71b 100644 --- a/openapi/ghe-2.15/operations/search/repos.json +++ b/openapi/ghe-2.15/operations/search/repos.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.15/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", + "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.15/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "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.15/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/topics.json b/openapi/ghe-2.15/operations/search/topics.json index 91dd9c1ad1..2d68a41ccf 100644 --- a/openapi/ghe-2.15/operations/search/topics.json +++ b/openapi/ghe-2.15/operations/search/topics.json @@ -21,12 +21,12 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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.15/v3/search/#constructing-a-search-query)." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/users-legacy.json b/openapi/ghe-2.15/operations/search/users-legacy.json index 3b4e6e0257..42c7651a1d 100644 --- a/openapi/ghe-2.15/operations/search/users-legacy.json +++ b/openapi/ghe-2.15/operations/search/users-legacy.json @@ -21,25 +21,27 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/search/users.json b/openapi/ghe-2.15/operations/search/users.json index 6e5e457006..31064d4dd7 100644 --- a/openapi/ghe-2.15/operations/search/users.json +++ b/openapi/ghe-2.15/operations/search/users.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.15/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.15/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "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.15/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "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.15/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/add-member.json b/openapi/ghe-2.15/operations/teams/add-member.json index bd17b4f0f3..dfa48ecda7 100644 --- a/openapi/ghe-2.15/operations/teams/add-member.json +++ b/openapi/ghe-2.15/operations/teams/add-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/add-or-update-membership.json b/openapi/ghe-2.15/operations/teams/add-or-update-membership.json index 6685fd5c04..83bdf58008 100644 --- a/openapi/ghe-2.15/operations/teams/add-or-update-membership.json +++ b/openapi/ghe-2.15/operations/teams/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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", + "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.", "enum": [ "member", "maintainer" diff --git a/openapi/ghe-2.15/operations/teams/add-or-update-project.json b/openapi/ghe-2.15/operations/teams/add-or-update-project.json index 0da071e91c..03b7159e77 100644 --- a/openapi/ghe-2.15/operations/teams/add-or-update-project.json +++ b/openapi/ghe-2.15/operations/teams/add-or-update-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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.15/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", + "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.15/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.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.15/operations/teams/add-or-update-repo.json b/openapi/ghe-2.15/operations/teams/add-or-update-repo.json index 75108b8da8..f88be71332 100644 --- a/openapi/ghe-2.15/operations/teams/add-or-update-repo.json +++ b/openapi/ghe-2.15/operations/teams/add-or-update-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -75,8 +75,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/ghe-2.15/operations/teams/check-manages-repo.json b/openapi/ghe-2.15/operations/teams/check-manages-repo.json index 469c3c387d..056470611f 100644 --- a/openapi/ghe-2.15/operations/teams/check-manages-repo.json +++ b/openapi/ghe-2.15/operations/teams/check-manages-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/create-discussion-comment.json b/openapi/ghe-2.15/operations/teams/create-discussion-comment.json index ffcdb0f7a6..21642c4f1f 100644 --- a/openapi/ghe-2.15/operations/teams/create-discussion-comment.json +++ b/openapi/ghe-2.15/operations/teams/create-discussion-comment.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -198,8 +198,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/teams/create-discussion.json b/openapi/ghe-2.15/operations/teams/create-discussion.json index 04ce5da352..e001a175f3 100644 --- a/openapi/ghe-2.15/operations/teams/create-discussion.json +++ b/openapi/ghe-2.15/operations/teams/create-discussion.json @@ -22,12 +22,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -204,16 +204,16 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." }, "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.15/operations/teams/create.json b/openapi/ghe-2.15/operations/teams/create.json index a0c2ed13cd..4647fba274 100644 --- a/openapi/ghe-2.15/operations/teams/create.json +++ b/openapi/ghe-2.15/operations/teams/create.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -197,38 +197,38 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "maintainers": { - "description": "The logins of organization members to add as maintainers of the team.", "type": "array", + "description": "The logins of organization members to add as maintainers of the team.", "items": { "type": "string" } }, "repo_names": { - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -237,12 +237,12 @@ "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" + "type": "integer", + "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." }, "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.15/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN.", - "type": "string" + "type": "string", + "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.15/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/teams/delete-discussion-comment.json b/openapi/ghe-2.15/operations/teams/delete-discussion-comment.json index d66a07dd4b..86239557ab 100644 --- a/openapi/ghe-2.15/operations/teams/delete-discussion-comment.json +++ b/openapi/ghe-2.15/operations/teams/delete-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/delete-discussion.json b/openapi/ghe-2.15/operations/teams/delete-discussion.json index a85438d328..16fde56aa1 100644 --- a/openapi/ghe-2.15/operations/teams/delete-discussion.json +++ b/openapi/ghe-2.15/operations/teams/delete-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/delete.json b/openapi/ghe-2.15/operations/teams/delete.json index b0dcf52345..e73eefc1ea 100644 --- a/openapi/ghe-2.15/operations/teams/delete.json +++ b/openapi/ghe-2.15/operations/teams/delete.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/get-discussion-comment.json b/openapi/ghe-2.15/operations/teams/get-discussion-comment.json index 5ba67c4589..0f8c0b42e0 100644 --- a/openapi/ghe-2.15/operations/teams/get-discussion-comment.json +++ b/openapi/ghe-2.15/operations/teams/get-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/get-discussion.json b/openapi/ghe-2.15/operations/teams/get-discussion.json index 4eae9cbde7..e3ba40b2e4 100644 --- a/openapi/ghe-2.15/operations/teams/get-discussion.json +++ b/openapi/ghe-2.15/operations/teams/get-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/get-member.json b/openapi/ghe-2.15/operations/teams/get-member.json index 35c595e5c6..14c5fc9749 100644 --- a/openapi/ghe-2.15/operations/teams/get-member.json +++ b/openapi/ghe-2.15/operations/teams/get-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/get-membership.json b/openapi/ghe-2.15/operations/teams/get-membership.json index a94ae654e4..fba41f8b97 100644 --- a/openapi/ghe-2.15/operations/teams/get-membership.json +++ b/openapi/ghe-2.15/operations/teams/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/get.json b/openapi/ghe-2.15/operations/teams/get.json index 83f9e854c0..69f8b4c90c 100644 --- a/openapi/ghe-2.15/operations/teams/get.json +++ b/openapi/ghe-2.15/operations/teams/get.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-child.json b/openapi/ghe-2.15/operations/teams/list-child.json index a252a74e01..e4127c1899 100644 --- a/openapi/ghe-2.15/operations/teams/list-child.json +++ b/openapi/ghe-2.15/operations/teams/list-child.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-discussion-comments.json b/openapi/ghe-2.15/operations/teams/list-discussion-comments.json index 9b826d6e97..c5e24b842c 100644 --- a/openapi/ghe-2.15/operations/teams/list-discussion-comments.json +++ b/openapi/ghe-2.15/operations/teams/list-discussion-comments.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-discussions.json b/openapi/ghe-2.15/operations/teams/list-discussions.json index 65d0f93b2f..6d01d8a715 100644 --- a/openapi/ghe-2.15/operations/teams/list-discussions.json +++ b/openapi/ghe-2.15/operations/teams/list-discussions.json @@ -22,16 +22,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-for-authenticated-user.json b/openapi/ghe-2.15/operations/teams/list-for-authenticated-user.json index 0aa3ef58f6..9b405298d5 100644 --- a/openapi/ghe-2.15/operations/teams/list-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/teams/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-members.json b/openapi/ghe-2.15/operations/teams/list-members.json index 8087b0baa8..35e1623d1d 100644 --- a/openapi/ghe-2.15/operations/teams/list-members.json +++ b/openapi/ghe-2.15/operations/teams/list-members.json @@ -21,16 +21,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-projects.json b/openapi/ghe-2.15/operations/teams/list-projects.json index 1dc7d9634f..0e84499641 100644 --- a/openapi/ghe-2.15/operations/teams/list-projects.json +++ b/openapi/ghe-2.15/operations/teams/list-projects.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list-repos.json b/openapi/ghe-2.15/operations/teams/list-repos.json index bd946ec42c..dc41e2c476 100644 --- a/openapi/ghe-2.15/operations/teams/list-repos.json +++ b/openapi/ghe-2.15/operations/teams/list-repos.json @@ -21,32 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/list.json b/openapi/ghe-2.15/operations/teams/list.json index e93a88745e..1817b5297a 100644 --- a/openapi/ghe-2.15/operations/teams/list.json +++ b/openapi/ghe-2.15/operations/teams/list.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/remove-member.json b/openapi/ghe-2.15/operations/teams/remove-member.json index 8c8ebff62b..224f401af3 100644 --- a/openapi/ghe-2.15/operations/teams/remove-member.json +++ b/openapi/ghe-2.15/operations/teams/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/remove-membership.json b/openapi/ghe-2.15/operations/teams/remove-membership.json index d8e9265d9c..69df04c528 100644 --- a/openapi/ghe-2.15/operations/teams/remove-membership.json +++ b/openapi/ghe-2.15/operations/teams/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/remove-project.json b/openapi/ghe-2.15/operations/teams/remove-project.json index 0ef243a142..8ff3123c8c 100644 --- a/openapi/ghe-2.15/operations/teams/remove-project.json +++ b/openapi/ghe-2.15/operations/teams/remove-project.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/remove-repo.json b/openapi/ghe-2.15/operations/teams/remove-repo.json index 04588c0fb9..4bcc79493b 100644 --- a/openapi/ghe-2.15/operations/teams/remove-repo.json +++ b/openapi/ghe-2.15/operations/teams/remove-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/review-project.json b/openapi/ghe-2.15/operations/teams/review-project.json index bcb7c89af7..9b656c719e 100644 --- a/openapi/ghe-2.15/operations/teams/review-project.json +++ b/openapi/ghe-2.15/operations/teams/review-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/teams/update-discussion-comment.json b/openapi/ghe-2.15/operations/teams/update-discussion-comment.json index c4f19320f9..7cac04bdc6 100644 --- a/openapi/ghe-2.15/operations/teams/update-discussion-comment.json +++ b/openapi/ghe-2.15/operations/teams/update-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -206,8 +206,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/teams/update-discussion.json b/openapi/ghe-2.15/operations/teams/update-discussion.json index b27b8a42c9..b4e2e0e82d 100644 --- a/openapi/ghe-2.15/operations/teams/update-discussion.json +++ b/openapi/ghe-2.15/operations/teams/update-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -212,12 +212,12 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." } } } diff --git a/openapi/ghe-2.15/operations/teams/update.json b/openapi/ghe-2.15/operations/teams/update.json index 2f1eef77f4..ba33780805 100644 --- a/openapi/ghe-2.15/operations/teams/update.json +++ b/openapi/ghe-2.15/operations/teams/update.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -197,24 +197,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -223,8 +223,8 @@ "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.15/operations/users/add-emails.json b/openapi/ghe-2.15/operations/users/add-emails.json index f88e4b1817..8a2bdd6427 100644 --- a/openapi/ghe-2.15/operations/users/add-emails.json +++ b/openapi/ghe-2.15/operations/users/add-emails.json @@ -72,8 +72,8 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub Enterprise account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Adds one or more email addresses to your GitHub Enterprise account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/users/check-following-for-user.json b/openapi/ghe-2.15/operations/users/check-following-for-user.json index 311c80b815..b01ff2a4a5 100644 --- a/openapi/ghe-2.15/operations/users/check-following-for-user.json +++ b/openapi/ghe-2.15/operations/users/check-following-for-user.json @@ -21,21 +21,21 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "target_user", + "description": "target_user parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "target_user parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/check-following.json b/openapi/ghe-2.15/operations/users/check-following.json index a89814431a..60fdc7a970 100644 --- a/openapi/ghe-2.15/operations/users/check-following.json +++ b/openapi/ghe-2.15/operations/users/check-following.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/create-gpg-key.json b/openapi/ghe-2.15/operations/users/create-gpg-key.json index 860babcc8d..0777838038 100644 --- a/openapi/ghe-2.15/operations/users/create-gpg-key.json +++ b/openapi/ghe-2.15/operations/users/create-gpg-key.json @@ -147,8 +147,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.15/operations/users/create-public-key.json b/openapi/ghe-2.15/operations/users/create-public-key.json index 1756b4f788..ed0fb4a61a 100644 --- a/openapi/ghe-2.15/operations/users/create-public-key.json +++ b/openapi/ghe-2.15/operations/users/create-public-key.json @@ -78,12 +78,12 @@ "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.15/operations/users/delete-emails.json b/openapi/ghe-2.15/operations/users/delete-emails.json index d41f6e07f0..74ce630df7 100644 --- a/openapi/ghe-2.15/operations/users/delete-emails.json +++ b/openapi/ghe-2.15/operations/users/delete-emails.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "emails": { - "description": "Deletes one or more email addresses from your GitHub Enterprise account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Deletes one or more email addresses from your GitHub Enterprise account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.15/operations/users/delete-gpg-key.json b/openapi/ghe-2.15/operations/users/delete-gpg-key.json index 80c08f4bfd..0e61fc6932 100644 --- a/openapi/ghe-2.15/operations/users/delete-gpg-key.json +++ b/openapi/ghe-2.15/operations/users/delete-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/delete-public-key.json b/openapi/ghe-2.15/operations/users/delete-public-key.json index 5cfc45ddc2..dbfc5f5696 100644 --- a/openapi/ghe-2.15/operations/users/delete-public-key.json +++ b/openapi/ghe-2.15/operations/users/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/follow.json b/openapi/ghe-2.15/operations/users/follow.json index 994f26d7f6..260bd7bd38 100644 --- a/openapi/ghe-2.15/operations/users/follow.json +++ b/openapi/ghe-2.15/operations/users/follow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/get-by-username.json b/openapi/ghe-2.15/operations/users/get-by-username.json index ee5ff0d97a..c1c6dbc728 100644 --- a/openapi/ghe-2.15/operations/users/get-by-username.json +++ b/openapi/ghe-2.15/operations/users/get-by-username.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/get-context-for-user.json b/openapi/ghe-2.15/operations/users/get-context-for-user.json index 6c698f11a7..4b9466d76d 100644 --- a/openapi/ghe-2.15/operations/users/get-context-for-user.json +++ b/openapi/ghe-2.15/operations/users/get-context-for-user.json @@ -22,16 +22,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "subject_type", + "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`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,18 +42,16 @@ "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", + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/get-gpg-key.json b/openapi/ghe-2.15/operations/users/get-gpg-key.json index 832a9d86b6..a0e7631130 100644 --- a/openapi/ghe-2.15/operations/users/get-gpg-key.json +++ b/openapi/ghe-2.15/operations/users/get-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/get-public-key.json b/openapi/ghe-2.15/operations/users/get-public-key.json index 11ad3a82f6..e00a7a1f39 100644 --- a/openapi/ghe-2.15/operations/users/get-public-key.json +++ b/openapi/ghe-2.15/operations/users/get-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-emails.json b/openapi/ghe-2.15/operations/users/list-emails.json index 15f5eb1ddb..9661392869 100644 --- a/openapi/ghe-2.15/operations/users/list-emails.json +++ b/openapi/ghe-2.15/operations/users/list-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-followers-for-authenticated-user.json b/openapi/ghe-2.15/operations/users/list-followers-for-authenticated-user.json index 5c23f1a2a6..4b959b1b12 100644 --- a/openapi/ghe-2.15/operations/users/list-followers-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/users/list-followers-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-followers-for-user.json b/openapi/ghe-2.15/operations/users/list-followers-for-user.json index 5a107d5c83..f1f730e9ae 100644 --- a/openapi/ghe-2.15/operations/users/list-followers-for-user.json +++ b/openapi/ghe-2.15/operations/users/list-followers-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-following-for-authenticated-user.json b/openapi/ghe-2.15/operations/users/list-following-for-authenticated-user.json index 09ae1b248d..2ce2211e85 100644 --- a/openapi/ghe-2.15/operations/users/list-following-for-authenticated-user.json +++ b/openapi/ghe-2.15/operations/users/list-following-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-following-for-user.json b/openapi/ghe-2.15/operations/users/list-following-for-user.json index f9b68a6682..eeada6c628 100644 --- a/openapi/ghe-2.15/operations/users/list-following-for-user.json +++ b/openapi/ghe-2.15/operations/users/list-following-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-gpg-keys-for-user.json b/openapi/ghe-2.15/operations/users/list-gpg-keys-for-user.json index cc41dc5eec..b568712e18 100644 --- a/openapi/ghe-2.15/operations/users/list-gpg-keys-for-user.json +++ b/openapi/ghe-2.15/operations/users/list-gpg-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-gpg-keys.json b/openapi/ghe-2.15/operations/users/list-gpg-keys.json index b1fdcd48e4..c62c29b788 100644 --- a/openapi/ghe-2.15/operations/users/list-gpg-keys.json +++ b/openapi/ghe-2.15/operations/users/list-gpg-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-public-emails.json b/openapi/ghe-2.15/operations/users/list-public-emails.json index 8d5989ba30..c6855bd2a8 100644 --- a/openapi/ghe-2.15/operations/users/list-public-emails.json +++ b/openapi/ghe-2.15/operations/users/list-public-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-public-keys-for-user.json b/openapi/ghe-2.15/operations/users/list-public-keys-for-user.json index 67e9441094..4210b553cd 100644 --- a/openapi/ghe-2.15/operations/users/list-public-keys-for-user.json +++ b/openapi/ghe-2.15/operations/users/list-public-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list-public-keys.json b/openapi/ghe-2.15/operations/users/list-public-keys.json index 1736938ae8..ca2d42900e 100644 --- a/openapi/ghe-2.15/operations/users/list-public-keys.json +++ b/openapi/ghe-2.15/operations/users/list-public-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/list.json b/openapi/ghe-2.15/operations/users/list.json index 01d6adfc0d..847aedebdf 100644 --- a/openapi/ghe-2.15/operations/users/list.json +++ b/openapi/ghe-2.15/operations/users/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last User that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last User that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/unfollow.json b/openapi/ghe-2.15/operations/users/unfollow.json index 7495303559..173a468ad8 100644 --- a/openapi/ghe-2.15/operations/users/unfollow.json +++ b/openapi/ghe-2.15/operations/users/unfollow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.15/operations/users/update-authenticated.json b/openapi/ghe-2.15/operations/users/update-authenticated.json index 1b4563fa6a..96e742b3e5 100644 --- a/openapi/ghe-2.15/operations/users/update-authenticated.json +++ b/openapi/ghe-2.15/operations/users/update-authenticated.json @@ -188,32 +188,32 @@ "type": "object", "properties": { "name": { - "description": "The new name of the user.", - "type": "string" + "type": "string", + "description": "The new name of the user." }, "email": { - "description": "The publicly visible email address of the user.", - "type": "string" + "type": "string", + "description": "The publicly visible email address of the user." }, "blog": { - "description": "The new blog URL of the user.", - "type": "string" + "type": "string", + "description": "The new blog URL of the user." }, "company": { - "description": "The new company of the user.", - "type": "string" + "type": "string", + "description": "The new company of the user." }, "location": { - "description": "The new location of the user.", - "type": "string" + "type": "string", + "description": "The new location of the user." }, "hireable": { - "description": "The new hiring availability of the user.", - "type": "boolean" + "type": "boolean", + "description": "The new hiring availability of the user." }, "bio": { - "description": "The new short biography of the user.", - "type": "string" + "type": "string", + "description": "The new short biography of the user." } } } diff --git a/openapi/ghe-2.16/operations/activity/check-starring-repo.json b/openapi/ghe-2.16/operations/activity/check-starring-repo.json index 92131dd519..f9ac67edb3 100644 --- a/openapi/ghe-2.16/operations/activity/check-starring-repo.json +++ b/openapi/ghe-2.16/operations/activity/check-starring-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/check-watching-repo-legacy.json b/openapi/ghe-2.16/operations/activity/check-watching-repo-legacy.json index 55f8dfc78b..af5332986f 100644 --- a/openapi/ghe-2.16/operations/activity/check-watching-repo-legacy.json +++ b/openapi/ghe-2.16/operations/activity/check-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/delete-repo-subscription.json b/openapi/ghe-2.16/operations/activity/delete-repo-subscription.json index d74eb0741f..d37e3c5a2d 100644 --- a/openapi/ghe-2.16/operations/activity/delete-repo-subscription.json +++ b/openapi/ghe-2.16/operations/activity/delete-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/delete-thread-subscription.json b/openapi/ghe-2.16/operations/activity/delete-thread-subscription.json index 3d61c8ec09..1be23feade 100644 --- a/openapi/ghe-2.16/operations/activity/delete-thread-subscription.json +++ b/openapi/ghe-2.16/operations/activity/delete-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/get-repo-subscription.json b/openapi/ghe-2.16/operations/activity/get-repo-subscription.json index c2a5997a84..816668a57e 100644 --- a/openapi/ghe-2.16/operations/activity/get-repo-subscription.json +++ b/openapi/ghe-2.16/operations/activity/get-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/get-thread-subscription.json b/openapi/ghe-2.16/operations/activity/get-thread-subscription.json index 0c47ab6ee9..258ec30edf 100644 --- a/openapi/ghe-2.16/operations/activity/get-thread-subscription.json +++ b/openapi/ghe-2.16/operations/activity/get-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/get-thread.json b/openapi/ghe-2.16/operations/activity/get-thread.json index 2554856cab..b66c7c908b 100644 --- a/openapi/ghe-2.16/operations/activity/get-thread.json +++ b/openapi/ghe-2.16/operations/activity/get-thread.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-events-for-org.json b/openapi/ghe-2.16/operations/activity/list-events-for-org.json index 64e7c36aa6..2bef5ad0fe 100644 --- a/openapi/ghe-2.16/operations/activity/list-events-for-org.json +++ b/openapi/ghe-2.16/operations/activity/list-events-for-org.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-events-for-user.json b/openapi/ghe-2.16/operations/activity/list-events-for-user.json index 4a16a0e4ce..3fb748a21e 100644 --- a/openapi/ghe-2.16/operations/activity/list-events-for-user.json +++ b/openapi/ghe-2.16/operations/activity/list-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-notifications-for-repo.json b/openapi/ghe-2.16/operations/activity/list-notifications-for-repo.json index 81cd5c0535..4908395252 100644 --- a/openapi/ghe-2.16/operations/activity/list-notifications-for-repo.json +++ b/openapi/ghe-2.16/operations/activity/list-notifications-for-repo.json @@ -21,79 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-notifications.json b/openapi/ghe-2.16/operations/activity/list-notifications.json index 0580e456b5..e7c54d3b57 100644 --- a/openapi/ghe-2.16/operations/activity/list-notifications.json +++ b/openapi/ghe-2.16/operations/activity/list-notifications.json @@ -21,61 +21,59 @@ }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-public-events-for-org.json b/openapi/ghe-2.16/operations/activity/list-public-events-for-org.json index 2f84e19cd1..22cb060b2c 100644 --- a/openapi/ghe-2.16/operations/activity/list-public-events-for-org.json +++ b/openapi/ghe-2.16/operations/activity/list-public-events-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-public-events-for-repo-network.json b/openapi/ghe-2.16/operations/activity/list-public-events-for-repo-network.json index cf573e679b..ac43470f32 100644 --- a/openapi/ghe-2.16/operations/activity/list-public-events-for-repo-network.json +++ b/openapi/ghe-2.16/operations/activity/list-public-events-for-repo-network.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-public-events-for-user.json b/openapi/ghe-2.16/operations/activity/list-public-events-for-user.json index 0f5c922f87..f379a5b6cf 100644 --- a/openapi/ghe-2.16/operations/activity/list-public-events-for-user.json +++ b/openapi/ghe-2.16/operations/activity/list-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-public-events.json b/openapi/ghe-2.16/operations/activity/list-public-events.json index fdd6b1d8aa..74fe16960a 100644 --- a/openapi/ghe-2.16/operations/activity/list-public-events.json +++ b/openapi/ghe-2.16/operations/activity/list-public-events.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-received-events-for-user.json b/openapi/ghe-2.16/operations/activity/list-received-events-for-user.json index 1c412dd6af..4959a9c825 100644 --- a/openapi/ghe-2.16/operations/activity/list-received-events-for-user.json +++ b/openapi/ghe-2.16/operations/activity/list-received-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-received-public-events-for-user.json b/openapi/ghe-2.16/operations/activity/list-received-public-events-for-user.json index dc1acee897..16693fb1ba 100644 --- a/openapi/ghe-2.16/operations/activity/list-received-public-events-for-user.json +++ b/openapi/ghe-2.16/operations/activity/list-received-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-repo-events.json b/openapi/ghe-2.16/operations/activity/list-repo-events.json index 4bea88a769..72e70ac1e5 100644 --- a/openapi/ghe-2.16/operations/activity/list-repo-events.json +++ b/openapi/ghe-2.16/operations/activity/list-repo-events.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-repos-starred-by-authenticated-user.json b/openapi/ghe-2.16/operations/activity/list-repos-starred-by-authenticated-user.json index 4c84323ba7..ce6064405e 100644 --- a/openapi/ghe-2.16/operations/activity/list-repos-starred-by-authenticated-user.json +++ b/openapi/ghe-2.16/operations/activity/list-repos-starred-by-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -29,13 +31,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -43,29 +45,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-repos-starred-by-user.json b/openapi/ghe-2.16/operations/activity/list-repos-starred-by-user.json index f95aebd4e7..6e9796d965 100644 --- a/openapi/ghe-2.16/operations/activity/list-repos-starred-by-user.json +++ b/openapi/ghe-2.16/operations/activity/list-repos-starred-by-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-repos-watched-by-user.json b/openapi/ghe-2.16/operations/activity/list-repos-watched-by-user.json index fe14c850bb..a990e8654b 100644 --- a/openapi/ghe-2.16/operations/activity/list-repos-watched-by-user.json +++ b/openapi/ghe-2.16/operations/activity/list-repos-watched-by-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-stargazers-for-repo.json b/openapi/ghe-2.16/operations/activity/list-stargazers-for-repo.json index 75f4db8cac..8f0517ab8f 100644 --- a/openapi/ghe-2.16/operations/activity/list-stargazers-for-repo.json +++ b/openapi/ghe-2.16/operations/activity/list-stargazers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-watched-repos-for-authenticated-user.json b/openapi/ghe-2.16/operations/activity/list-watched-repos-for-authenticated-user.json index a512083037..3e52c091f7 100644 --- a/openapi/ghe-2.16/operations/activity/list-watched-repos-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/activity/list-watched-repos-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/list-watchers-for-repo.json b/openapi/ghe-2.16/operations/activity/list-watchers-for-repo.json index 74235418a3..9275678af7 100644 --- a/openapi/ghe-2.16/operations/activity/list-watchers-for-repo.json +++ b/openapi/ghe-2.16/operations/activity/list-watchers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/mark-as-read.json b/openapi/ghe-2.16/operations/activity/mark-as-read.json index ef9fd16363..08b181a1fb 100644 --- a/openapi/ghe-2.16/operations/activity/mark-as-read.json +++ b/openapi/ghe-2.16/operations/activity/mark-as-read.json @@ -48,8 +48,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/ghe-2.16/operations/activity/mark-notifications-as-read-for-repo.json b/openapi/ghe-2.16/operations/activity/mark-notifications-as-read-for-repo.json index 7b2febad0c..227f8ab0e6 100644 --- a/openapi/ghe-2.16/operations/activity/mark-notifications-as-read-for-repo.json +++ b/openapi/ghe-2.16/operations/activity/mark-notifications-as-read-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/ghe-2.16/operations/activity/mark-thread-as-read.json b/openapi/ghe-2.16/operations/activity/mark-thread-as-read.json index cc1b1cd95f..21c7558e2c 100644 --- a/openapi/ghe-2.16/operations/activity/mark-thread-as-read.json +++ b/openapi/ghe-2.16/operations/activity/mark-thread-as-read.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/set-repo-subscription.json b/openapi/ghe-2.16/operations/activity/set-repo-subscription.json index 2a8f711f0c..7390312fa7 100644 --- a/openapi/ghe-2.16/operations/activity/set-repo-subscription.json +++ b/openapi/ghe-2.16/operations/activity/set-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -93,12 +93,12 @@ "type": "object", "properties": { "subscribed": { - "description": "Determines if notifications should be received from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if notifications should be received from this repository." }, "ignored": { - "description": "Determines if all notifications should be blocked from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if all notifications should be blocked from this repository." } } } diff --git a/openapi/ghe-2.16/operations/activity/set-thread-subscription.json b/openapi/ghe-2.16/operations/activity/set-thread-subscription.json index 8ac587daaa..24bf2459d9 100644 --- a/openapi/ghe-2.16/operations/activity/set-thread-subscription.json +++ b/openapi/ghe-2.16/operations/activity/set-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { @@ -84,8 +84,8 @@ "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", + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", "default": false } } diff --git a/openapi/ghe-2.16/operations/activity/star-repo.json b/openapi/ghe-2.16/operations/activity/star-repo.json index 00af8991de..6e3f211f48 100644 --- a/openapi/ghe-2.16/operations/activity/star-repo.json +++ b/openapi/ghe-2.16/operations/activity/star-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/stop-watching-repo-legacy.json b/openapi/ghe-2.16/operations/activity/stop-watching-repo-legacy.json index a02941fc0f..e521951ccd 100644 --- a/openapi/ghe-2.16/operations/activity/stop-watching-repo-legacy.json +++ b/openapi/ghe-2.16/operations/activity/stop-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/unstar-repo.json b/openapi/ghe-2.16/operations/activity/unstar-repo.json index 9d22502f9f..d0fa4c78d8 100644 --- a/openapi/ghe-2.16/operations/activity/unstar-repo.json +++ b/openapi/ghe-2.16/operations/activity/unstar-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/activity/watch-repo-legacy.json b/openapi/ghe-2.16/operations/activity/watch-repo-legacy.json index 04064c3ca1..f6004b5ee3 100644 --- a/openapi/ghe-2.16/operations/activity/watch-repo-legacy.json +++ b/openapi/ghe-2.16/operations/activity/watch-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/add-repo-to-installation.json b/openapi/ghe-2.16/operations/apps/add-repo-to-installation.json index c87eed63a8..1714cf854c 100644 --- a/openapi/ghe-2.16/operations/apps/add-repo-to-installation.json +++ b/openapi/ghe-2.16/operations/apps/add-repo-to-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/create-content-attachment.json b/openapi/ghe-2.16/operations/apps/create-content-attachment.json index 0a93b7685e..48abe4c4ed 100644 --- a/openapi/ghe-2.16/operations/apps/create-content-attachment.json +++ b/openapi/ghe-2.16/operations/apps/create-content-attachment.json @@ -22,12 +22,12 @@ }, { "name": "content_reference_id", + "description": "content_reference_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "content_reference_id parameter" + } } ], "responses": { @@ -76,12 +76,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", - "type": "string" + "type": "string", + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request." }, "body": { - "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", - "type": "string" + "type": "string", + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/apps/create-from-manifest.json b/openapi/ghe-2.16/operations/apps/create-from-manifest.json index 37b47aa676..0f5af20d1b 100644 --- a/openapi/ghe-2.16/operations/apps/create-from-manifest.json +++ b/openapi/ghe-2.16/operations/apps/create-from-manifest.json @@ -21,12 +21,12 @@ }, { "name": "code", + "description": "code parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "code parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/create-installation-token.json b/openapi/ghe-2.16/operations/apps/create-installation-token.json index 33b521031c..ca04ba5408 100644 --- a/openapi/ghe-2.16/operations/apps/create-installation-token.json +++ b/openapi/ghe-2.16/operations/apps/create-installation-token.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/get-by-slug.json b/openapi/ghe-2.16/operations/apps/get-by-slug.json index c3394c58e6..f6bcd5569f 100644 --- a/openapi/ghe-2.16/operations/apps/get-by-slug.json +++ b/openapi/ghe-2.16/operations/apps/get-by-slug.json @@ -22,12 +22,12 @@ }, { "name": "app_slug", + "description": "app_slug parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "app_slug parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/get-installation.json b/openapi/ghe-2.16/operations/apps/get-installation.json index 4e49735722..6954d1b834 100644 --- a/openapi/ghe-2.16/operations/apps/get-installation.json +++ b/openapi/ghe-2.16/operations/apps/get-installation.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/get-org-installation.json b/openapi/ghe-2.16/operations/apps/get-org-installation.json index f8da625f1e..4dcf09860d 100644 --- a/openapi/ghe-2.16/operations/apps/get-org-installation.json +++ b/openapi/ghe-2.16/operations/apps/get-org-installation.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/get-repo-installation.json b/openapi/ghe-2.16/operations/apps/get-repo-installation.json index 468f30f7ea..394642bffe 100644 --- a/openapi/ghe-2.16/operations/apps/get-repo-installation.json +++ b/openapi/ghe-2.16/operations/apps/get-repo-installation.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/get-user-installation.json b/openapi/ghe-2.16/operations/apps/get-user-installation.json index 55403b221c..57633912c7 100644 --- a/openapi/ghe-2.16/operations/apps/get-user-installation.json +++ b/openapi/ghe-2.16/operations/apps/get-user-installation.json @@ -22,12 +22,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/list-installation-repos-for-authenticated-user.json b/openapi/ghe-2.16/operations/apps/list-installation-repos-for-authenticated-user.json index 9f4d989fd4..f75bf2ff3e 100644 --- a/openapi/ghe-2.16/operations/apps/list-installation-repos-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/apps/list-installation-repos-for-authenticated-user.json @@ -22,32 +22,30 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/list-installations-for-authenticated-user.json b/openapi/ghe-2.16/operations/apps/list-installations-for-authenticated-user.json index 92a0631b5a..f90d8e6555 100644 --- a/openapi/ghe-2.16/operations/apps/list-installations-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/apps/list-installations-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/list-installations.json b/openapi/ghe-2.16/operations/apps/list-installations.json index cec556cb2f..ec6c7796bf 100644 --- a/openapi/ghe-2.16/operations/apps/list-installations.json +++ b/openapi/ghe-2.16/operations/apps/list-installations.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/list-repos.json b/openapi/ghe-2.16/operations/apps/list-repos.json index d3629362c3..75f2b4a31d 100644 --- a/openapi/ghe-2.16/operations/apps/list-repos.json +++ b/openapi/ghe-2.16/operations/apps/list-repos.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/apps/remove-repo-from-installation.json b/openapi/ghe-2.16/operations/apps/remove-repo-from-installation.json index f24902387b..4b02453212 100644 --- a/openapi/ghe-2.16/operations/apps/remove-repo-from-installation.json +++ b/openapi/ghe-2.16/operations/apps/remove-repo-from-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/create-suite.json b/openapi/ghe-2.16/operations/checks/create-suite.json index 9f222729ad..2d281a058b 100644 --- a/openapi/ghe-2.16/operations/checks/create-suite.json +++ b/openapi/ghe-2.16/operations/checks/create-suite.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -480,8 +480,8 @@ "type": "object", "properties": { "head_sha": { - "description": "The sha of the head commit.", - "type": "string" + "type": "string", + "description": "The sha of the head commit." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/checks/create.json b/openapi/ghe-2.16/operations/checks/create.json index 06d8373e2a..21138d1d63 100644 --- a/openapi/ghe-2.16/operations/checks/create.json +++ b/openapi/ghe-2.16/operations/checks/create.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -271,24 +271,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "head_sha": { - "description": "The SHA of the commit.", - "type": "string" + "type": "string", + "description": "The SHA of the commit." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -297,12 +297,12 @@ "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" + "type": "string", + "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`." }, "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", + "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`.", "enum": [ "success", "failure", @@ -313,54 +313,54 @@ ] }, "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" + "type": "string", + "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`." }, "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.16/v3/checks/runs/#output-object) description.", "type": "object", + "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.16/v3/checks/runs/#output-object) description.", "properties": { "title": { - "description": "The title of the check run.", - "type": "string" + "type": "string", + "description": "The title of the check run." }, "summary": { - "description": "The summary of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The summary of the check run. This parameter supports Markdown." }, "text": { - "description": "The details of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The details of the check run. This parameter supports Markdown." }, "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.16/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.16/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "type": "array", + "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.16/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.16/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -368,16 +368,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -390,22 +390,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.16/v3/checks/runs/#images-object) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.16/v3/checks/runs/#images-object) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -421,22 +421,22 @@ ] }, "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.16/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.16/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.16/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.16/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "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.16/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.16/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.16/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.16/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/checks/get-suite.json b/openapi/ghe-2.16/operations/checks/get-suite.json index 9b3f9676a9..d7846c37e5 100644 --- a/openapi/ghe-2.16/operations/checks/get-suite.json +++ b/openapi/ghe-2.16/operations/checks/get-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/get.json b/openapi/ghe-2.16/operations/checks/get.json index 028cd3d07c..4081811d7a 100644 --- a/openapi/ghe-2.16/operations/checks/get.json +++ b/openapi/ghe-2.16/operations/checks/get.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/list-annotations.json b/openapi/ghe-2.16/operations/checks/list-annotations.json index 5f48797425..e4451c01fb 100644 --- a/openapi/ghe-2.16/operations/checks/list-annotations.json +++ b/openapi/ghe-2.16/operations/checks/list-annotations.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/list-for-ref.json b/openapi/ghe-2.16/operations/checks/list-for-ref.json index c978690bcc..511cdfcece 100644 --- a/openapi/ghe-2.16/operations/checks/list-for-ref.json +++ b/openapi/ghe-2.16/operations/checks/list-for-ref.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/list-for-suite.json b/openapi/ghe-2.16/operations/checks/list-for-suite.json index 734700df33..29b4058aaa 100644 --- a/openapi/ghe-2.16/operations/checks/list-for-suite.json +++ b/openapi/ghe-2.16/operations/checks/list-for-suite.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/list-suites-for-ref.json b/openapi/ghe-2.16/operations/checks/list-suites-for-ref.json index 15c39b5c50..62eb9352c1 100644 --- a/openapi/ghe-2.16/operations/checks/list-suites-for-ref.json +++ b/openapi/ghe-2.16/operations/checks/list-suites-for-ref.json @@ -22,68 +22,66 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", "in": "query", + "required": false, "schema": { "type": "integer" - }, - "required": false, - "description": "Filters check suites by GitHub App `id`." + } }, { "name": "check_name", + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.16/v3/checks/runs/).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.16/v3/checks/runs/)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/rerequest-suite.json b/openapi/ghe-2.16/operations/checks/rerequest-suite.json index 0b38635dd5..5475386933 100644 --- a/openapi/ghe-2.16/operations/checks/rerequest-suite.json +++ b/openapi/ghe-2.16/operations/checks/rerequest-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/checks/set-suites-preferences.json b/openapi/ghe-2.16/operations/checks/set-suites-preferences.json index 93a3dc4f46..7e5a7c16de 100644 --- a/openapi/ghe-2.16/operations/checks/set-suites-preferences.json +++ b/openapi/ghe-2.16/operations/checks/set-suites-preferences.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -402,18 +402,18 @@ "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.16/v3/checks/suites/#auto_trigger_checks-object) description for details.", "type": "array", + "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.16/v3/checks/suites/#auto_trigger_checks-object) description for details.", "items": { "type": "object", "properties": { "app_id": { - "description": "The `id` of the GitHub App.", - "type": "integer" + "type": "integer", + "description": "The `id` of the GitHub App." }, "setting": { - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "type": "boolean", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/checks/update.json b/openapi/ghe-2.16/operations/checks/update.json index a175b75752..215b2c2986 100644 --- a/openapi/ghe-2.16/operations/checks/update.json +++ b/openapi/ghe-2.16/operations/checks/update.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { @@ -286,24 +286,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "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" + "type": "string", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -311,8 +311,8 @@ ] }, "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", + "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`.", "enum": [ "success", "failure", @@ -323,54 +323,54 @@ ] }, "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" + "type": "string", + "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`." }, "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.16/v3/checks/runs/#output-object-1) description.", "type": "object", + "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.16/v3/checks/runs/#output-object-1) description.", "properties": { "title": { - "description": "**Required**.", - "type": "string" + "type": "string", + "description": "**Required**." }, "summary": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "text": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "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.16/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.16/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "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.16/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.16/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -378,16 +378,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -400,22 +400,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.16/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.16/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -430,22 +430,22 @@ ] }, "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.16/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.16/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "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.16/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.16/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/codes-of-conduct/get-conduct-code.json b/openapi/ghe-2.16/operations/codes-of-conduct/get-conduct-code.json index 1bc65793ff..f59196a309 100644 --- a/openapi/ghe-2.16/operations/codes-of-conduct/get-conduct-code.json +++ b/openapi/ghe-2.16/operations/codes-of-conduct/get-conduct-code.json @@ -22,12 +22,12 @@ }, { "name": "key", + "description": "key parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/codes-of-conduct/get-for-repo.json b/openapi/ghe-2.16/operations/codes-of-conduct/get-for-repo.json index 82c0c7d267..1ab0ccd9c7 100644 --- a/openapi/ghe-2.16/operations/codes-of-conduct/get-for-repo.json +++ b/openapi/ghe-2.16/operations/codes-of-conduct/get-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/add-authorized-ssh-key.json b/openapi/ghe-2.16/operations/enterprise-admin/add-authorized-ssh-key.json index 8a55f89cce..2596ad1108 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/add-authorized-ssh-key.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/add-authorized-ssh-key.json @@ -66,8 +66,8 @@ "type": "object", "properties": { "authorized_key": { - "description": "The path to the public SSH key.", - "type": "string" + "type": "string", + "description": "The path to the public SSH key." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/create-global-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/create-global-hook.json index b3411207ea..a8e0c073f7 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/create-global-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/create-global-hook.json @@ -105,28 +105,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.16/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.16/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -134,15 +134,15 @@ ] }, "events": { - "description": "The [events](https://developer.github.com/enterprise/2.16/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", + "description": "The [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/enterprise-admin/create-impersonation-o-auth-token.json b/openapi/ghe-2.16/operations/enterprise-admin/create-impersonation-o-auth-token.json index ec3c769316..2de98c00c1 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/create-impersonation-o-auth-token.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/create-impersonation-o-auth-token.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -116,8 +116,8 @@ "type": "object", "properties": { "scopes": { - "description": "A list of [scopes](https://developer.github.com/enterprise/2.16/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "type": "array", + "description": "A list of [scopes](https://developer.github.com/enterprise/2.16/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/create-org.json b/openapi/ghe-2.16/operations/enterprise-admin/create-org.json index f1f08d69c9..b98dca15b1 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/create-org.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/create-org.json @@ -93,16 +93,16 @@ "type": "object", "properties": { "login": { - "description": "The organization's username.", - "type": "string" + "type": "string", + "description": "The organization's username." }, "admin": { - "description": "The login of the user who will manage this organization.", - "type": "string" + "type": "string", + "description": "The login of the user who will manage this organization." }, "profile_name": { - "description": "The organization's display name.", - "type": "string" + "type": "string", + "description": "The organization's display name." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-environment.json b/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-environment.json index 9c054c7a02..fd9be1ed25 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-environment.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-environment.json @@ -98,12 +98,12 @@ "type": "object", "properties": { "name": { - "description": "The new pre-receive environment's name.", - "type": "string" + "type": "string", + "description": "The new pre-receive environment's name." }, "image_url": { - "description": "URL from which to download a tarball of this environment.", - "type": "string" + "type": "string", + "description": "URL from which to download a tarball of this environment." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-hook.json index 27a69e3faa..03c9fae541 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/create-pre-receive-hook.json @@ -135,30 +135,30 @@ "type": "object", "properties": { "name": { - "description": "The name of the hook.", - "type": "string" + "type": "string", + "description": "The name of the hook." }, "script": { - "description": "The script that the hook runs.", - "type": "string" + "type": "string", + "description": "The script that the hook runs." }, "script_repository": { - "description": "The GitHub repository where the script is kept.", "type": "object", + "description": "The GitHub repository where the script is kept.", "properties": {} }, "environment": { - "description": "The pre-receive environment where the script is executed.", "type": "object", + "description": "The pre-receive environment where the script is executed.", "properties": {} }, "enforcement": { - "description": "The state of enforcement for this hook. default: `disabled`", - "type": "string" + "type": "string", + "description": "The state of enforcement for this hook. default: `disabled`" }, "allow_downstream_configuration": { - "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "type": "boolean" + "type": "boolean", + "description": "Whether enforcement can be overridden at the org or repo level. default: `false`" } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/create-user.json b/openapi/ghe-2.16/operations/enterprise-admin/create-user.json index 1092610361..a8cafb8254 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/create-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/create-user.json @@ -111,12 +111,12 @@ "type": "object", "properties": { "login": { - "description": "The user's username.", - "type": "string" + "type": "string", + "description": "The user's username." }, "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 Server authentication guide](https://help.github.com/enterprise/2.16/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", - "type": "string" + "type": "string", + "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 Server authentication guide](https://help.github.com/enterprise/2.16/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/delete-global-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/delete-global-hook.json index 989754d8f1..b3b4e52ccb 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/delete-global-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/delete-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/delete-impersonation-o-auth-token.json b/openapi/ghe-2.16/operations/enterprise-admin/delete-impersonation-o-auth-token.json index 5e5cb092e7..d00b61a1f1 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/delete-impersonation-o-auth-token.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/delete-impersonation-o-auth-token.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-environment.json b/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-environment.json index c1dae1ab66..0a47a31446 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-environment.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-hook.json index a227de68be..44a3b4def9 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/delete-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/delete-public-key.json b/openapi/ghe-2.16/operations/enterprise-admin/delete-public-key.json index eb9d8dd402..690570f484 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/delete-public-key.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_ids", + "description": "key_ids parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key_ids parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/delete-user.json b/openapi/ghe-2.16/operations/enterprise-admin/delete-user.json index f05b4ae2b9..746578d18a 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/delete-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/delete-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json b/openapi/ghe-2.16/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json index 5e9b3c2171..e7e063876e 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/enable-or-disable-maintenance-mode.json b/openapi/ghe-2.16/operations/enterprise-admin/enable-or-disable-maintenance-mode.json index bd9287a41c..3b59844657 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/enable-or-disable-maintenance-mode.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/enable-or-disable-maintenance-mode.json @@ -81,8 +81,8 @@ "type": "object", "properties": { "maintenance": { - "description": "A JSON string with the attributes `enabled` and `when`.", - "type": "string" + "type": "string", + "description": "A JSON string with the attributes `enabled` and `when`." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-global-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/get-global-hook.json index db366ed30f..656ca47b65 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-global-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment-download-status.json b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment-download-status.json index 60e100f234..0b9e054545 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment-download-status.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment-download-status.json @@ -21,39 +21,39 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } }, { "name": "state", + "description": "The state of the most recent download.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The state of the most recent download." + } }, { "name": "downloaded_at", + "description": "The time when the most recent download started.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The time when the most recent download started." + } }, { "name": "message", + "description": "On failure, this will have any error messages produced.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "On failure, this will have any error messages produced." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment.json b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment.json index e433fee719..870b2b641b 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-org.json b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-org.json index 1e0f6922b9..06f078e1b4 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-org.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-repo.json b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-repo.json index 12cf7dee9c..fe96c18ee7 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-repo.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook.json index 9cdd378585..67a1293f83 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/get-type-stats.json b/openapi/ghe-2.16/operations/enterprise-admin/get-type-stats.json index 6875cf7682..463a169952 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/get-type-stats.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/get-type-stats.json @@ -21,12 +21,12 @@ }, { "name": "type", + "description": "type parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "type parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/list-global-hooks.json b/openapi/ghe-2.16/operations/enterprise-admin/list-global-hooks.json index 5154864750..1fa0631143 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/list-global-hooks.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/list-global-hooks.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-environments.json b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-environments.json index 35a560f263..789f88e708 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-environments.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-environments.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-org.json b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-org.json index f87d2efbbe..7a395864a8 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-org.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json index 0707ade11d..168a6bae47 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks.json b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks.json index 941a369287..717ee207a6 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/list-pre-receive-hooks.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/modify-settings.json b/openapi/ghe-2.16/operations/enterprise-admin/modify-settings.json index 70ee46d0ac..4dcb2b31f1 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/modify-settings.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/modify-settings.json @@ -48,8 +48,8 @@ "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" + "type": "string", + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/ping-global-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/ping-global-hook.json index bdcff970d7..0c223be6b9 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/ping-global-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/ping-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json b/openapi/ghe-2.16/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json index 7435cbb830..dcd37e75a6 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/queue-indexing-job.json b/openapi/ghe-2.16/operations/enterprise-admin/queue-indexing-job.json index 27be0061c8..f52fd79909 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/queue-indexing-job.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/queue-indexing-job.json @@ -60,8 +60,8 @@ "type": "object", "properties": { "target": { - "description": "A string representing the item to index.", - "type": "string" + "type": "string", + "description": "A string representing the item to index." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/remove-authorized-ssh-key.json b/openapi/ghe-2.16/operations/enterprise-admin/remove-authorized-ssh-key.json index 59f3097710..1d0d3b5a86 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/remove-authorized-ssh-key.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/remove-authorized-ssh-key.json @@ -66,8 +66,8 @@ "type": "object", "properties": { "authorized_key": { - "description": "The path to the public SSH key.", - "type": "string" + "type": "string", + "description": "The path to the public SSH key." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json b/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json index 7e6f1d1bd3..8615424c01 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json b/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json index 4430ec83cc..71833e2d9b 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/rename-org.json b/openapi/ghe-2.16/operations/enterprise-admin/rename-org.json index b6e8ac6b5b..e43d02bc60 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/rename-org.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/rename-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -72,8 +72,8 @@ "type": "object", "properties": { "login": { - "description": "The organization's new name.", - "type": "string" + "type": "string", + "description": "The organization's new name." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/rename-user.json b/openapi/ghe-2.16/operations/enterprise-admin/rename-user.json index 056a4e271a..1daaf25472 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/rename-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/rename-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -72,8 +72,8 @@ "type": "object", "properties": { "login": { - "description": "The user's new username.", - "type": "string" + "type": "string", + "description": "The user's new username." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/enterprise-admin/suspend-user.json b/openapi/ghe-2.16/operations/enterprise-admin/suspend-user.json index 80a78d7972..1adea6fe93 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/suspend-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/suspend-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -57,8 +57,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-team.json b/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-team.json index ceb7ca7633..0c959ebf44 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-team.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-team.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-user.json b/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-user.json index a21bf5c2d9..14ca4393a5 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/sync-ldap-mapping-for-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/trigger-pre-receive-environment-download.json b/openapi/ghe-2.16/operations/enterprise-admin/trigger-pre-receive-environment-download.json index 1505e2fccc..0e08180a0f 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/trigger-pre-receive-environment-download.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/trigger-pre-receive-environment-download.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/unsuspend-user.json b/openapi/ghe-2.16/operations/enterprise-admin/unsuspend-user.json index da5f9670c1..c4fcd758b5 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/unsuspend-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/unsuspend-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -57,8 +57,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-global-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/update-global-hook.json index 4cba5fedf1..4eaf322d7f 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-global-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -111,24 +111,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.16/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.16/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -136,15 +136,15 @@ ] }, "events": { - "description": "The [events](https://developer.github.com/enterprise/2.16/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", + "description": "The [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-team.json b/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-team.json index d896901fab..99d954ed1c 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-team.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-team.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -102,8 +102,8 @@ "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" + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." } } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-user.json b/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-user.json index 98e0562f4d..92232ef76a 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-user.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-ldap-mapping-for-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -123,8 +123,8 @@ "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" + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." } } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-environment.json b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-environment.json index fa2608cabd..e44a8aa770 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-environment.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "name": { - "description": "This pre-receive environment's new name.", - "type": "string" + "type": "string", + "description": "This pre-receive environment's new name." }, "image_url": { - "description": "URL from which to download a tarball of this environment.", - "type": "string" + "type": "string", + "description": "URL from which to download a tarball of this environment." } } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json index 0866a30b69..87feb9f380 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json index 09287300e4..da450eca90 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook.json b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook.json index 2263573795..bfa759723b 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/update-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/enterprise-admin/upgrade-license.json b/openapi/ghe-2.16/operations/enterprise-admin/upgrade-license.json index cd265c81f0..dac3396cb1 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/upgrade-license.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/upgrade-license.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "license": { - "description": "The content of your new _.ghl_ license file.", - "type": "string" + "type": "string", + "description": "The content of your new _.ghl_ license file." } } } diff --git a/openapi/ghe-2.16/operations/enterprise-admin/upload-license-for-first-time.json b/openapi/ghe-2.16/operations/enterprise-admin/upload-license-for-first-time.json index 11542df9cc..0fc612cc3a 100644 --- a/openapi/ghe-2.16/operations/enterprise-admin/upload-license-for-first-time.json +++ b/openapi/ghe-2.16/operations/enterprise-admin/upload-license-for-first-time.json @@ -48,16 +48,16 @@ "type": "object", "properties": { "license": { - "description": "The content of your _.ghl_ license file.", - "type": "string" + "type": "string", + "description": "The content of your _.ghl_ license file." }, "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" + "type": "string", + "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." }, "settings": { - "description": "An optional JSON string containing the installation settings.", - "type": "string" + "type": "string", + "description": "An optional JSON string containing the installation settings." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/gists/check-is-starred.json b/openapi/ghe-2.16/operations/gists/check-is-starred.json index 88b87d08a9..10f0b813eb 100644 --- a/openapi/ghe-2.16/operations/gists/check-is-starred.json +++ b/openapi/ghe-2.16/operations/gists/check-is-starred.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/create-comment.json b/openapi/ghe-2.16/operations/gists/create-comment.json index 51261f4f15..e3e69748c8 100644 --- a/openapi/ghe-2.16/operations/gists/create-comment.json +++ b/openapi/ghe-2.16/operations/gists/create-comment.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -143,8 +143,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/gists/create.json b/openapi/ghe-2.16/operations/gists/create.json index 6f295218c7..2440a43907 100644 --- a/openapi/ghe-2.16/operations/gists/create.json +++ b/openapi/ghe-2.16/operations/gists/create.json @@ -442,22 +442,22 @@ "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", + "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`.", "properties": { "content": { - "description": "The content of the file.", - "type": "string" + "type": "string", + "description": "The content of the file." } } }, "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "public": { - "description": "When `true`, the gist will be public and available for anyone to see.", "type": "boolean", + "description": "When `true`, the gist will be public and available for anyone to see.", "default": false } }, diff --git a/openapi/ghe-2.16/operations/gists/delete-comment.json b/openapi/ghe-2.16/operations/gists/delete-comment.json index 77b0737b08..63f9874f12 100644 --- a/openapi/ghe-2.16/operations/gists/delete-comment.json +++ b/openapi/ghe-2.16/operations/gists/delete-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/delete.json b/openapi/ghe-2.16/operations/gists/delete.json index 5c9864430d..83582b101c 100644 --- a/openapi/ghe-2.16/operations/gists/delete.json +++ b/openapi/ghe-2.16/operations/gists/delete.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/fork.json b/openapi/ghe-2.16/operations/gists/fork.json index 5a0e1c651d..cee461fa1d 100644 --- a/openapi/ghe-2.16/operations/gists/fork.json +++ b/openapi/ghe-2.16/operations/gists/fork.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/get-comment.json b/openapi/ghe-2.16/operations/gists/get-comment.json index da545cdd64..c5bc657b2c 100644 --- a/openapi/ghe-2.16/operations/gists/get-comment.json +++ b/openapi/ghe-2.16/operations/gists/get-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/get-revision.json b/openapi/ghe-2.16/operations/gists/get-revision.json index 86ffadd571..bc91fc4765 100644 --- a/openapi/ghe-2.16/operations/gists/get-revision.json +++ b/openapi/ghe-2.16/operations/gists/get-revision.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/get.json b/openapi/ghe-2.16/operations/gists/get.json index 24d530ad16..07c268cd57 100644 --- a/openapi/ghe-2.16/operations/gists/get.json +++ b/openapi/ghe-2.16/operations/gists/get.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list-comments.json b/openapi/ghe-2.16/operations/gists/list-comments.json index b4fbe553a7..ea720ac8d5 100644 --- a/openapi/ghe-2.16/operations/gists/list-comments.json +++ b/openapi/ghe-2.16/operations/gists/list-comments.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list-commits.json b/openapi/ghe-2.16/operations/gists/list-commits.json index 03aeadaa73..b439147410 100644 --- a/openapi/ghe-2.16/operations/gists/list-commits.json +++ b/openapi/ghe-2.16/operations/gists/list-commits.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list-forks.json b/openapi/ghe-2.16/operations/gists/list-forks.json index d01c3e0b87..c496fd68f3 100644 --- a/openapi/ghe-2.16/operations/gists/list-forks.json +++ b/openapi/ghe-2.16/operations/gists/list-forks.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list-public-for-user.json b/openapi/ghe-2.16/operations/gists/list-public-for-user.json index 8d9e94d7a3..9805aee784 100644 --- a/openapi/ghe-2.16/operations/gists/list-public-for-user.json +++ b/openapi/ghe-2.16/operations/gists/list-public-for-user.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list-public.json b/openapi/ghe-2.16/operations/gists/list-public.json index c246f3af04..4c00c5c80b 100644 --- a/openapi/ghe-2.16/operations/gists/list-public.json +++ b/openapi/ghe-2.16/operations/gists/list-public.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list-starred.json b/openapi/ghe-2.16/operations/gists/list-starred.json index 75bd483395..f43d5c71c5 100644 --- a/openapi/ghe-2.16/operations/gists/list-starred.json +++ b/openapi/ghe-2.16/operations/gists/list-starred.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/list.json b/openapi/ghe-2.16/operations/gists/list.json index 79c6051937..a6dd068013 100644 --- a/openapi/ghe-2.16/operations/gists/list.json +++ b/openapi/ghe-2.16/operations/gists/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/star.json b/openapi/ghe-2.16/operations/gists/star.json index 330661416d..117292d2d3 100644 --- a/openapi/ghe-2.16/operations/gists/star.json +++ b/openapi/ghe-2.16/operations/gists/star.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/unstar.json b/openapi/ghe-2.16/operations/gists/unstar.json index 669107e9d3..a0327ffa5f 100644 --- a/openapi/ghe-2.16/operations/gists/unstar.json +++ b/openapi/ghe-2.16/operations/gists/unstar.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/gists/update-comment.json b/openapi/ghe-2.16/operations/gists/update-comment.json index 244cd49e9c..1748471644 100644 --- a/openapi/ghe-2.16/operations/gists/update-comment.json +++ b/openapi/ghe-2.16/operations/gists/update-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -152,8 +152,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/gists/update.json b/openapi/ghe-2.16/operations/gists/update.json index 0b0bd33e61..c7c0bdc1ae 100644 --- a/openapi/ghe-2.16/operations/gists/update.json +++ b/openapi/ghe-2.16/operations/gists/update.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -451,20 +451,20 @@ "type": "object", "properties": { "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "files": { - "description": "The filenames and content that make up this gist.", "type": "object", + "description": "The filenames and content that make up this gist.", "properties": { "content": { - "description": "The updated content of the file.", - "type": "string" + "type": "string", + "description": "The updated content of the file." }, "filename": { - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "type": "string" + "type": "string", + "description": "The new name for this file. To delete a file, set the value of the filename to `null`." } } } diff --git a/openapi/ghe-2.16/operations/git/create-blob.json b/openapi/ghe-2.16/operations/git/create-blob.json index f430f84c64..2ce25b2719 100644 --- a/openapi/ghe-2.16/operations/git/create-blob.json +++ b/openapi/ghe-2.16/operations/git/create-blob.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,12 +81,12 @@ "type": "object", "properties": { "content": { - "description": "The new blob's content.", - "type": "string" + "type": "string", + "description": "The new blob's content." }, "encoding": { - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } }, diff --git a/openapi/ghe-2.16/operations/git/create-commit.json b/openapi/ghe-2.16/operations/git/create-commit.json index 2a26563d71..940760e3b9 100644 --- a/openapi/ghe-2.16/operations/git/create-commit.json +++ b/openapi/ghe-2.16/operations/git/create-commit.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -157,59 +157,59 @@ "type": "object", "properties": { "message": { - "description": "The commit message", - "type": "string" + "type": "string", + "description": "The commit message" }, "tree": { - "description": "The SHA of the tree object this commit points to", - "type": "string" + "type": "string", + "description": "The SHA of the tree object this commit points to" }, "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", + "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.", "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/git/create-ref.json b/openapi/ghe-2.16/operations/git/create-ref.json index 3e58224643..c11f445da3 100644 --- a/openapi/ghe-2.16/operations/git/create-ref.json +++ b/openapi/ghe-2.16/operations/git/create-ref.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -98,12 +98,12 @@ "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" + "type": "string", + "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." }, "sha": { - "description": "The SHA1 value for this reference.", - "type": "string" + "type": "string", + "description": "The SHA1 value for this reference." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/git/create-tag.json b/openapi/ghe-2.16/operations/git/create-tag.json index 72559e2335..9900a09d60 100644 --- a/openapi/ghe-2.16/operations/git/create-tag.json +++ b/openapi/ghe-2.16/operations/git/create-tag.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -135,20 +135,20 @@ "type": "object", "properties": { "tag": { - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "type": "string" + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." }, "message": { - "description": "The tag message.", - "type": "string" + "type": "string", + "description": "The tag message." }, "object": { - "description": "The SHA of the git object this is tagging.", - "type": "string" + "type": "string", + "description": "The SHA of the git object this is tagging." }, "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", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", "enum": [ "commit", "tree", @@ -156,20 +156,20 @@ ] }, "tagger": { - "description": "An object with information about the individual creating the tag.", "type": "object", + "description": "An object with information about the individual creating the tag.", "properties": { "name": { - "description": "The name of the author of the tag", - "type": "string" + "type": "string", + "description": "The name of the author of the tag" }, "email": { - "description": "The email of the author of the tag", - "type": "string" + "type": "string", + "description": "The email of the author of the tag" }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/ghe-2.16/operations/git/create-tree.json b/openapi/ghe-2.16/operations/git/create-tree.json index 532267f1ab..277f074e11 100644 --- a/openapi/ghe-2.16/operations/git/create-tree.json +++ b/openapi/ghe-2.16/operations/git/create-tree.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -107,18 +107,18 @@ "type": "object", "properties": { "tree": { - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "items": { "type": "object", "properties": { "path": { - "description": "The file referenced in the tree.", - "type": "string" + "type": "string", + "description": "The file referenced in the tree." }, "mode": { - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", "type": "string", + "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.", "enum": [ "100644", "100755", @@ -128,8 +128,8 @@ ] }, "type": { - "description": "Either `blob`, `tree`, or `commit`.", "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", "enum": [ "blob", "tree", @@ -137,19 +137,19 @@ ] }, "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" + "type": "string", + "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." }, "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" + "type": "string", + "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." } } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/git/delete-ref.json b/openapi/ghe-2.16/operations/git/delete-ref.json index 8598c20d36..a5e7abea5b 100644 --- a/openapi/ghe-2.16/operations/git/delete-ref.json +++ b/openapi/ghe-2.16/operations/git/delete-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/git/get-blob.json b/openapi/ghe-2.16/operations/git/get-blob.json index f57c0658cc..28f62b57fd 100644 --- a/openapi/ghe-2.16/operations/git/get-blob.json +++ b/openapi/ghe-2.16/operations/git/get-blob.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "file_sha", + "description": "file_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "file_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/git/get-commit.json b/openapi/ghe-2.16/operations/git/get-commit.json index a925b08242..8fca88f3da 100644 --- a/openapi/ghe-2.16/operations/git/get-commit.json +++ b/openapi/ghe-2.16/operations/git/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/git/get-tag.json b/openapi/ghe-2.16/operations/git/get-tag.json index f95a537bfe..5e7d2822fb 100644 --- a/openapi/ghe-2.16/operations/git/get-tag.json +++ b/openapi/ghe-2.16/operations/git/get-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag_sha", + "description": "tag_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/git/get-tree.json b/openapi/ghe-2.16/operations/git/get-tree.json index df678b6429..ef92f56f01 100644 --- a/openapi/ghe-2.16/operations/git/get-tree.json +++ b/openapi/ghe-2.16/operations/git/get-tree.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-tree", "tags": [ "git" ], @@ -21,41 +21,41 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tree_sha", + "description": "tree_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tree_sha parameter" + } }, { "name": "recursive", + "description": "recursive parameter", "in": "query", "schema": { "type": "integer", "enum": [ 1 ] - }, - "description": "recursive parameter" + } } ], "responses": { @@ -70,7 +70,7 @@ }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" + "source": "octokit.git.getTree({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" } ], "x-github": { diff --git a/openapi/ghe-2.16/operations/git/update-ref.json b/openapi/ghe-2.16/operations/git/update-ref.json index eff3a75f6a..4448a13da4 100644 --- a/openapi/ghe-2.16/operations/git/update-ref.json +++ b/openapi/ghe-2.16/operations/git/update-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "sha": { - "description": "The SHA1 value to set this reference to", - "type": "string" + "type": "string", + "description": "The SHA1 value to set this reference to" }, "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.16/operations/gitignore/get-template.json b/openapi/ghe-2.16/operations/gitignore/get-template.json index b7097b177b..ce7a70a6d4 100644 --- a/openapi/ghe-2.16/operations/gitignore/get-template.json +++ b/openapi/ghe-2.16/operations/gitignore/get-template.json @@ -21,12 +21,12 @@ }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/add-assignees.json b/openapi/ghe-2.16/operations/issues/add-assignees.json index 8665faa9aa..078e6e5f6e 100644 --- a/openapi/ghe-2.16/operations/issues/add-assignees.json +++ b/openapi/ghe-2.16/operations/issues/add-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -503,8 +503,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/issues/add-labels.json b/openapi/ghe-2.16/operations/issues/add-labels.json index 590c323c1c..44c3c95862 100644 --- a/openapi/ghe-2.16/operations/issues/add-labels.json +++ b/openapi/ghe-2.16/operations/issues/add-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -118,8 +118,8 @@ "type": "object", "properties": { "labels": { - "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "type": "array", + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/issues/check-assignee.json b/openapi/ghe-2.16/operations/issues/check-assignee.json index df2a779330..1eba16f14c 100644 --- a/openapi/ghe-2.16/operations/issues/check-assignee.json +++ b/openapi/ghe-2.16/operations/issues/check-assignee.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "assignee", + "description": "assignee parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "assignee parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/create-comment.json b/openapi/ghe-2.16/operations/issues/create-comment.json index 172c72afc1..a7e41b5f32 100644 --- a/openapi/ghe-2.16/operations/issues/create-comment.json +++ b/openapi/ghe-2.16/operations/issues/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -175,8 +175,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/issues/create-label.json b/openapi/ghe-2.16/operations/issues/create-label.json index e51c5c0578..f90327a69e 100644 --- a/openapi/ghe-2.16/operations/issues/create-label.json +++ b/openapi/ghe-2.16/operations/issues/create-label.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "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" + "type": "string", + "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/)." }, "color": { - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "type": "string" + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." }, "description": { - "description": "A short description of the label.", - "type": "string" + "type": "string", + "description": "A short description of the label." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/issues/create-milestone.json b/openapi/ghe-2.16/operations/issues/create-milestone.json index 2f433bf153..ba9b24e34b 100644 --- a/openapi/ghe-2.16/operations/issues/create-milestone.json +++ b/openapi/ghe-2.16/operations/issues/create-milestone.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -192,12 +192,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/issues/create.json b/openapi/ghe-2.16/operations/issues/create.json index 4d98a5f7e7..62d0f13d3c 100644 --- a/openapi/ghe-2.16/operations/issues/create.json +++ b/openapi/ghe-2.16/operations/issues/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -524,31 +524,31 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "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" + "type": "string", + "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.**_" }, "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" + "type": "integer", + "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._" }, "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", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/issues/delete-comment.json b/openapi/ghe-2.16/operations/issues/delete-comment.json index b5e14b31ec..ed28b6832c 100644 --- a/openapi/ghe-2.16/operations/issues/delete-comment.json +++ b/openapi/ghe-2.16/operations/issues/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/delete-label.json b/openapi/ghe-2.16/operations/issues/delete-label.json index 7c8e189bb2..7f73083445 100644 --- a/openapi/ghe-2.16/operations/issues/delete-label.json +++ b/openapi/ghe-2.16/operations/issues/delete-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/delete-milestone.json b/openapi/ghe-2.16/operations/issues/delete-milestone.json index 198851c96c..e3fc86a381 100644 --- a/openapi/ghe-2.16/operations/issues/delete-milestone.json +++ b/openapi/ghe-2.16/operations/issues/delete-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/get-comment.json b/openapi/ghe-2.16/operations/issues/get-comment.json index b80d620c20..92984a71f0 100644 --- a/openapi/ghe-2.16/operations/issues/get-comment.json +++ b/openapi/ghe-2.16/operations/issues/get-comment.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/get-event.json b/openapi/ghe-2.16/operations/issues/get-event.json index a9916cfb65..34951c0087 100644 --- a/openapi/ghe-2.16/operations/issues/get-event.json +++ b/openapi/ghe-2.16/operations/issues/get-event.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "event_id", + "description": "event_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "event_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/get-label.json b/openapi/ghe-2.16/operations/issues/get-label.json index 73cc0269cc..03ae73103d 100644 --- a/openapi/ghe-2.16/operations/issues/get-label.json +++ b/openapi/ghe-2.16/operations/issues/get-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/get-milestone.json b/openapi/ghe-2.16/operations/issues/get-milestone.json index e42bea7155..7731240be8 100644 --- a/openapi/ghe-2.16/operations/issues/get-milestone.json +++ b/openapi/ghe-2.16/operations/issues/get-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/get.json b/openapi/ghe-2.16/operations/issues/get.json index a1dc292881..50531fac5f 100644 --- a/openapi/ghe-2.16/operations/issues/get.json +++ b/openapi/ghe-2.16/operations/issues/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-assignees.json b/openapi/ghe-2.16/operations/issues/list-assignees.json index dd3eb3f5fa..c075aabd8f 100644 --- a/openapi/ghe-2.16/operations/issues/list-assignees.json +++ b/openapi/ghe-2.16/operations/issues/list-assignees.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-comments-for-repo.json b/openapi/ghe-2.16/operations/issues/list-comments-for-repo.json index a9136befa6..1d2a0de705 100644 --- a/openapi/ghe-2.16/operations/issues/list-comments-for-repo.json +++ b/openapi/ghe-2.16/operations/issues/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Either `created` or `updated`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,31 +49,29 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Either `created` or `updated`." + } }, { "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter." + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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": { diff --git a/openapi/ghe-2.16/operations/issues/list-comments.json b/openapi/ghe-2.16/operations/issues/list-comments.json index e4ccee7e15..1a10d84bc3 100644 --- a/openapi/ghe-2.16/operations/issues/list-comments.json +++ b/openapi/ghe-2.16/operations/issues/list-comments.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-events-for-repo.json b/openapi/ghe-2.16/operations/issues/list-events-for-repo.json index 8db51ef0a6..571991080f 100644 --- a/openapi/ghe-2.16/operations/issues/list-events-for-repo.json +++ b/openapi/ghe-2.16/operations/issues/list-events-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-events-for-timeline.json b/openapi/ghe-2.16/operations/issues/list-events-for-timeline.json index 70a749e339..719a861d2c 100644 --- a/openapi/ghe-2.16/operations/issues/list-events-for-timeline.json +++ b/openapi/ghe-2.16/operations/issues/list-events-for-timeline.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-events.json b/openapi/ghe-2.16/operations/issues/list-events.json index 4528561c02..7c8000c01d 100644 --- a/openapi/ghe-2.16/operations/issues/list-events.json +++ b/openapi/ghe-2.16/operations/issues/list-events.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-for-authenticated-user.json b/openapi/ghe-2.16/operations/issues/list-for-authenticated-user.json index 9fad289c06..00d584d2ef 100644 --- a/openapi/ghe-2.16/operations/issues/list-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/issues/list-for-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-for-org.json b/openapi/ghe-2.16/operations/issues/list-for-org.json index fc2c8758ba..1aa19a53f7 100644 --- a/openapi/ghe-2.16/operations/issues/list-for-org.json +++ b/openapi/ghe-2.16/operations/issues/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -41,13 +43,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,13 +82,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -94,38 +96,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-for-repo.json b/openapi/ghe-2.16/operations/issues/list-for-repo.json index 7eb9d13207..663bece7a0 100644 --- a/openapi/ghe-2.16/operations/issues/list-for-repo.json +++ b/openapi/ghe-2.16/operations/issues/list-for-repo.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone", + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", "in": "query", + "required": false, "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,49 +59,49 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", "in": "query", + "required": false, "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", + "description": "The user that created the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The user that created the issue." + } }, { "name": "mentioned", + "description": "A user that's mentioned in the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A user that's mentioned in the issue." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -108,13 +110,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -122,38 +124,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-labels-for-milestone.json b/openapi/ghe-2.16/operations/issues/list-labels-for-milestone.json index f68ad80d1a..5ef1ad1bdf 100644 --- a/openapi/ghe-2.16/operations/issues/list-labels-for-milestone.json +++ b/openapi/ghe-2.16/operations/issues/list-labels-for-milestone.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-labels-for-repo.json b/openapi/ghe-2.16/operations/issues/list-labels-for-repo.json index 969c21515b..b5e6a591bb 100644 --- a/openapi/ghe-2.16/operations/issues/list-labels-for-repo.json +++ b/openapi/ghe-2.16/operations/issues/list-labels-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-labels-on-issue.json b/openapi/ghe-2.16/operations/issues/list-labels-on-issue.json index 222e730733..74ed4a569c 100644 --- a/openapi/ghe-2.16/operations/issues/list-labels-on-issue.json +++ b/openapi/ghe-2.16/operations/issues/list-labels-on-issue.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list-milestones-for-repo.json b/openapi/ghe-2.16/operations/issues/list-milestones-for-repo.json index f65564c093..3d50a3b633 100644 --- a/openapi/ghe-2.16/operations/issues/list-milestones-for-repo.json +++ b/openapi/ghe-2.16/operations/issues/list-milestones-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,13 +50,13 @@ "all" ], "default": "open" - }, - "required": false, - "description": "The state of the milestone. Either `open`, `closed`, or `all`." + } }, { "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,13 +64,13 @@ "completeness" ], "default": "due_on" - }, - "required": false, - "description": "What to sort results by. Either `due_on` or `completeness`." + } }, { "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -76,29 +78,25 @@ "desc" ], "default": "asc" - }, - "required": false, - "description": "The direction of the sort. Either `asc` or `desc`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/list.json b/openapi/ghe-2.16/operations/issues/list.json index 655e897737..585125130d 100644 --- a/openapi/ghe-2.16/operations/issues/list.json +++ b/openapi/ghe-2.16/operations/issues/list.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/lock.json b/openapi/ghe-2.16/operations/issues/lock.json index d84f2b90ee..1359e1b06f 100644 --- a/openapi/ghe-2.16/operations/issues/lock.json +++ b/openapi/ghe-2.16/operations/issues/lock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -85,8 +85,8 @@ "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", + "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`", "enum": [ "off-topic", "too heated", diff --git a/openapi/ghe-2.16/operations/issues/remove-assignees.json b/openapi/ghe-2.16/operations/issues/remove-assignees.json index 4ab1568006..4d46363021 100644 --- a/openapi/ghe-2.16/operations/issues/remove-assignees.json +++ b/openapi/ghe-2.16/operations/issues/remove-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -483,8 +483,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/issues/remove-label.json b/openapi/ghe-2.16/operations/issues/remove-label.json index 8f41d45c8e..31c1cce179 100644 --- a/openapi/ghe-2.16/operations/issues/remove-label.json +++ b/openapi/ghe-2.16/operations/issues/remove-label.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/remove-labels.json b/openapi/ghe-2.16/operations/issues/remove-labels.json index 91dfd347af..ea0cf8ff38 100644 --- a/openapi/ghe-2.16/operations/issues/remove-labels.json +++ b/openapi/ghe-2.16/operations/issues/remove-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/replace-labels.json b/openapi/ghe-2.16/operations/issues/replace-labels.json index 4e8fcbaf48..c2eff28bb6 100644 --- a/openapi/ghe-2.16/operations/issues/replace-labels.json +++ b/openapi/ghe-2.16/operations/issues/replace-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -118,8 +118,8 @@ "type": "object", "properties": { "labels": { - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "type": "array", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/issues/unlock.json b/openapi/ghe-2.16/operations/issues/unlock.json index 90ec3e96f9..bcd81f5f6a 100644 --- a/openapi/ghe-2.16/operations/issues/unlock.json +++ b/openapi/ghe-2.16/operations/issues/unlock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/issues/update-comment.json b/openapi/ghe-2.16/operations/issues/update-comment.json index 4126753553..3c3bf940ea 100644 --- a/openapi/ghe-2.16/operations/issues/update-comment.json +++ b/openapi/ghe-2.16/operations/issues/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -164,8 +164,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/issues/update-milestone.json b/openapi/ghe-2.16/operations/issues/update-milestone.json index 284dd4246a..59b5dad681 100644 --- a/openapi/ghe-2.16/operations/issues/update-milestone.json +++ b/openapi/ghe-2.16/operations/issues/update-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { @@ -198,12 +198,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -211,12 +211,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/ghe-2.16/operations/issues/update.json b/openapi/ghe-2.16/operations/issues/update.json index df0f853494..7cd43b4692 100644 --- a/openapi/ghe-2.16/operations/issues/update.json +++ b/openapi/ghe-2.16/operations/issues/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -542,40 +542,40 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "assignee": { - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "type": "string" + "type": "string", + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**" }, "state": { - "description": "State of the issue. Either `open` or `closed`.", "type": "string", + "description": "State of the issue. Either `open` or `closed`.", "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", + "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._", "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", + "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._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/licenses/get-for-repo.json b/openapi/ghe-2.16/operations/licenses/get-for-repo.json index 7eba71bc1e..b57bf72f20 100644 --- a/openapi/ghe-2.16/operations/licenses/get-for-repo.json +++ b/openapi/ghe-2.16/operations/licenses/get-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/licenses/get.json b/openapi/ghe-2.16/operations/licenses/get.json index fc082d3b89..b5124b9ec5 100644 --- a/openapi/ghe-2.16/operations/licenses/get.json +++ b/openapi/ghe-2.16/operations/licenses/get.json @@ -21,12 +21,12 @@ }, { "name": "license", + "description": "license parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "license parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/markdown/render.json b/openapi/ghe-2.16/operations/markdown/render.json index ff3ffe519c..5f944ee564 100644 --- a/openapi/ghe-2.16/operations/markdown/render.json +++ b/openapi/ghe-2.16/operations/markdown/render.json @@ -48,12 +48,12 @@ "type": "object", "properties": { "text": { - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "type": "string" + "type": "string", + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less." }, "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", + "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.", "enum": [ "markdown", "gfm" @@ -61,8 +61,8 @@ "default": "markdown" }, "context": { - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", - "type": "string" + "type": "string", + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/check-authorization.json b/openapi/ghe-2.16/operations/oauth-authorizations/check-authorization.json index 06282601e2..eb960b8234 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/check-authorization.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/check-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/create-authorization.json b/openapi/ghe-2.16/operations/oauth-authorizations/create-authorization.json index 392f431c8a..3e117d5d9c 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/create-authorization.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/create-authorization.json @@ -107,31 +107,31 @@ "type": "object", "properties": { "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "client_id": { - "description": "The 20 character OAuth app client key for which to create the token.", - "type": "string" + "type": "string", + "description": "The 20 character OAuth app client key for which to create the token." }, "client_secret": { - "description": "The 40 character OAuth app client secret for which to create the token.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret for which to create the token." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/delete-authorization.json b/openapi/ghe-2.16/operations/oauth-authorizations/delete-authorization.json index cc2d5846a8..bfa26f3850 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/delete-authorization.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/delete-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/delete-grant.json b/openapi/ghe-2.16/operations/oauth-authorizations/delete-grant.json index e72682a701..268956d020 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/delete-grant.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/delete-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/get-authorization.json b/openapi/ghe-2.16/operations/oauth-authorizations/get-authorization.json index 0cd94183c8..29b8c74a21 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/get-authorization.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/get-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/get-grant.json b/openapi/ghe-2.16/operations/oauth-authorizations/get-grant.json index 41112beffe..199abd5530 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/get-grant.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/get-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json b/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json index b95e605eb1..bc1a1fdac7 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "fingerprint", + "description": "fingerprint parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "fingerprint parameter" + } } ], "responses": { @@ -80,23 +80,23 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app.json b/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app.json index f1c265c939..d178a81148 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/get-or-create-authorization-for-app.json @@ -21,12 +21,12 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } } ], "responses": { @@ -57,27 +57,27 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "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.16/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", - "type": "string" + "type": "string", + "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.16/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint)." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/list-authorizations.json b/openapi/ghe-2.16/operations/oauth-authorizations/list-authorizations.json index 0c5904757b..c598a34b99 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/list-authorizations.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/list-authorizations.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/list-grants.json b/openapi/ghe-2.16/operations/oauth-authorizations/list-grants.json index d97c0e9e1b..8aefd7dd1c 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/list-grants.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/list-grants.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/reset-authorization.json b/openapi/ghe-2.16/operations/oauth-authorizations/reset-authorization.json index d0c62b2258..5ac5b89a8a 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/reset-authorization.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/reset-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/revoke-authorization-for-application.json b/openapi/ghe-2.16/operations/oauth-authorizations/revoke-authorization-for-application.json index 60a76dae16..da211870f0 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/revoke-authorization-for-application.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/revoke-authorization-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/revoke-grant-for-application.json b/openapi/ghe-2.16/operations/oauth-authorizations/revoke-grant-for-application.json index a48fc7ed4d..0a78de8411 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/revoke-grant-for-application.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/revoke-grant-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/oauth-authorizations/update-authorization.json b/openapi/ghe-2.16/operations/oauth-authorizations/update-authorization.json index 012089efa0..a76bfaac86 100644 --- a/openapi/ghe-2.16/operations/oauth-authorizations/update-authorization.json +++ b/openapi/ghe-2.16/operations/oauth-authorizations/update-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { @@ -116,37 +116,37 @@ "type": "object", "properties": { "scopes": { - "description": "Replaces the authorization scopes with these.", "type": "array", + "description": "Replaces the authorization scopes with these.", "items": { "type": "string" } }, "add_scopes": { - "description": "A list of scopes to add to this authorization.", "type": "array", + "description": "A list of scopes to add to this authorization.", "items": { "type": "string" } }, "remove_scopes": { - "description": "A list of scopes to remove from this authorization.", "type": "array", + "description": "A list of scopes to remove from this authorization.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } } } diff --git a/openapi/ghe-2.16/operations/orgs/add-or-update-membership.json b/openapi/ghe-2.16/operations/orgs/add-or-update-membership.json index be85773257..4781123a58 100644 --- a/openapi/ghe-2.16/operations/orgs/add-or-update-membership.json +++ b/openapi/ghe-2.16/operations/orgs/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -187,8 +187,8 @@ "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", + "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.", "enum": [ "admin", "member" diff --git a/openapi/ghe-2.16/operations/orgs/check-membership.json b/openapi/ghe-2.16/operations/orgs/check-membership.json index 23c80a2281..20b2f19478 100644 --- a/openapi/ghe-2.16/operations/orgs/check-membership.json +++ b/openapi/ghe-2.16/operations/orgs/check-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/check-public-membership.json b/openapi/ghe-2.16/operations/orgs/check-public-membership.json index 97319cd3df..26522f1e93 100644 --- a/openapi/ghe-2.16/operations/orgs/check-public-membership.json +++ b/openapi/ghe-2.16/operations/orgs/check-public-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/conceal-membership.json b/openapi/ghe-2.16/operations/orgs/conceal-membership.json index 4b91bc203e..2831de43dc 100644 --- a/openapi/ghe-2.16/operations/orgs/conceal-membership.json +++ b/openapi/ghe-2.16/operations/orgs/conceal-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/convert-member-to-outside-collaborator.json b/openapi/ghe-2.16/operations/orgs/convert-member-to-outside-collaborator.json index cc7b853117..16eab6017b 100644 --- a/openapi/ghe-2.16/operations/orgs/convert-member-to-outside-collaborator.json +++ b/openapi/ghe-2.16/operations/orgs/convert-member-to-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/create-hook.json b/openapi/ghe-2.16/operations/orgs/create-hook.json index f012289afb..fe1b3a6222 100644 --- a/openapi/ghe-2.16/operations/orgs/create-hook.json +++ b/openapi/ghe-2.16/operations/orgs/create-hook.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -104,28 +104,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/orgs/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/orgs/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.16/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.16/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -133,8 +133,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -143,8 +143,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/orgs/delete-hook.json b/openapi/ghe-2.16/operations/orgs/delete-hook.json index 5234efcd27..ba5802f787 100644 --- a/openapi/ghe-2.16/operations/orgs/delete-hook.json +++ b/openapi/ghe-2.16/operations/orgs/delete-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/get-hook.json b/openapi/ghe-2.16/operations/orgs/get-hook.json index de601d2f1a..33d259a704 100644 --- a/openapi/ghe-2.16/operations/orgs/get-hook.json +++ b/openapi/ghe-2.16/operations/orgs/get-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/get-membership-for-authenticated-user.json b/openapi/ghe-2.16/operations/orgs/get-membership-for-authenticated-user.json index ba266cf507..7ecbc7564a 100644 --- a/openapi/ghe-2.16/operations/orgs/get-membership-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/orgs/get-membership-for-authenticated-user.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/get-membership.json b/openapi/ghe-2.16/operations/orgs/get-membership.json index 41ca205c40..4f318e40a2 100644 --- a/openapi/ghe-2.16/operations/orgs/get-membership.json +++ b/openapi/ghe-2.16/operations/orgs/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/get.json b/openapi/ghe-2.16/operations/orgs/get.json index e3b7560012..7a5b3a14fe 100644 --- a/openapi/ghe-2.16/operations/orgs/get.json +++ b/openapi/ghe-2.16/operations/orgs/get.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-for-authenticated-user.json b/openapi/ghe-2.16/operations/orgs/list-for-authenticated-user.json index 053b16542a..5414d70818 100644 --- a/openapi/ghe-2.16/operations/orgs/list-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/orgs/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-for-user.json b/openapi/ghe-2.16/operations/orgs/list-for-user.json index 3d67926056..ae006c7bc1 100644 --- a/openapi/ghe-2.16/operations/orgs/list-for-user.json +++ b/openapi/ghe-2.16/operations/orgs/list-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-hooks.json b/openapi/ghe-2.16/operations/orgs/list-hooks.json index 6250a64cc1..e77eae6ed0 100644 --- a/openapi/ghe-2.16/operations/orgs/list-hooks.json +++ b/openapi/ghe-2.16/operations/orgs/list-hooks.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-members.json b/openapi/ghe-2.16/operations/orgs/list-members.json index 071cadda8a..4f677ec346 100644 --- a/openapi/ghe-2.16/operations/orgs/list-members.json +++ b/openapi/ghe-2.16/operations/orgs/list-members.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "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", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-memberships.json b/openapi/ghe-2.16/operations/orgs/list-memberships.json index 48f0a14e50..2570356fe2 100644 --- a/openapi/ghe-2.16/operations/orgs/list-memberships.json +++ b/openapi/ghe-2.16/operations/orgs/list-memberships.json @@ -21,36 +21,34 @@ }, { "name": "state", + "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.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-outside-collaborators.json b/openapi/ghe-2.16/operations/orgs/list-outside-collaborators.json index 98b3bd0266..d32ec68358 100644 --- a/openapi/ghe-2.16/operations/orgs/list-outside-collaborators.json +++ b/openapi/ghe-2.16/operations/orgs/list-outside-collaborators.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,29 +40,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list-public-members.json b/openapi/ghe-2.16/operations/orgs/list-public-members.json index a98c9d384d..54f1a65ed9 100644 --- a/openapi/ghe-2.16/operations/orgs/list-public-members.json +++ b/openapi/ghe-2.16/operations/orgs/list-public-members.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/list.json b/openapi/ghe-2.16/operations/orgs/list.json index 8a484b81a4..b133abfa25 100644 --- a/openapi/ghe-2.16/operations/orgs/list.json +++ b/openapi/ghe-2.16/operations/orgs/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last Organization that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Organization that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/ping-hook.json b/openapi/ghe-2.16/operations/orgs/ping-hook.json index 93aa7837e0..a9750007c0 100644 --- a/openapi/ghe-2.16/operations/orgs/ping-hook.json +++ b/openapi/ghe-2.16/operations/orgs/ping-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/publicize-membership.json b/openapi/ghe-2.16/operations/orgs/publicize-membership.json index a540328fc9..353ada1831 100644 --- a/openapi/ghe-2.16/operations/orgs/publicize-membership.json +++ b/openapi/ghe-2.16/operations/orgs/publicize-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/remove-member.json b/openapi/ghe-2.16/operations/orgs/remove-member.json index 0f0eca2d29..7e679e287a 100644 --- a/openapi/ghe-2.16/operations/orgs/remove-member.json +++ b/openapi/ghe-2.16/operations/orgs/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/remove-membership.json b/openapi/ghe-2.16/operations/orgs/remove-membership.json index 1c4c5328cc..a21c5d866d 100644 --- a/openapi/ghe-2.16/operations/orgs/remove-membership.json +++ b/openapi/ghe-2.16/operations/orgs/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/remove-outside-collaborator.json b/openapi/ghe-2.16/operations/orgs/remove-outside-collaborator.json index 385cdc0fb2..1cdb6c7626 100644 --- a/openapi/ghe-2.16/operations/orgs/remove-outside-collaborator.json +++ b/openapi/ghe-2.16/operations/orgs/remove-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/orgs/update-hook.json b/openapi/ghe-2.16/operations/orgs/update-hook.json index 96af31b194..66c4a2e9d8 100644 --- a/openapi/ghe-2.16/operations/orgs/update-hook.json +++ b/openapi/ghe-2.16/operations/orgs/update-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -113,24 +113,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/orgs/hooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/orgs/hooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.16/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.16/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -138,8 +138,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -148,8 +148,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.16/operations/orgs/update-membership.json b/openapi/ghe-2.16/operations/orgs/update-membership.json index 7fbabd54df..2ab10e2e07 100644 --- a/openapi/ghe-2.16/operations/orgs/update-membership.json +++ b/openapi/ghe-2.16/operations/orgs/update-membership.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -178,8 +178,8 @@ "type": "object", "properties": { "state": { - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "type": "string", + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "enum": [ "active" ] diff --git a/openapi/ghe-2.16/operations/orgs/update.json b/openapi/ghe-2.16/operations/orgs/update.json index 77bd7d40a2..30536c4e84 100644 --- a/openapi/ghe-2.16/operations/orgs/update.json +++ b/openapi/ghe-2.16/operations/orgs/update.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -185,40 +185,40 @@ "type": "object", "properties": { "billing_email": { - "description": "Billing email address. This address is not publicized.", - "type": "string" + "type": "string", + "description": "Billing email address. This address is not publicized." }, "company": { - "description": "The company name.", - "type": "string" + "type": "string", + "description": "The company name." }, "email": { - "description": "The publicly visible email address.", - "type": "string" + "type": "string", + "description": "The publicly visible email address." }, "location": { - "description": "The location.", - "type": "string" + "type": "string", + "description": "The location." }, "name": { - "description": "The shorthand name of the company.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, "description": { - "description": "The description of the company.", - "type": "string" + "type": "string", + "description": "The description of the company." }, "has_organization_projects": { - "description": "Toggles whether organization projects are enabled for the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether organization projects are enabled for the organization." }, "has_repository_projects": { - "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization." }, "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", + "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.", "enum": [ "read", "write", @@ -228,13 +228,13 @@ "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. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.16/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.16/v3/orgs/#members_can_create_repositories) for details.", "type": "boolean", + "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. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.16/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.16/v3/orgs/#members_can_create_repositories) for details.", "default": true }, "members_allowed_repository_creation_type": { - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/enterprise/2.16/v3/orgs/#members_can_create_repositories) for details.", "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/enterprise/2.16/v3/orgs/#members_can_create_repositories) for details.", "enum": [ "all", "private", diff --git a/openapi/ghe-2.16/operations/projects/add-collaborator.json b/openapi/ghe-2.16/operations/projects/add-collaborator.json index e4e4eca4be..498941509c 100644 --- a/openapi/ghe-2.16/operations/projects/add-collaborator.json +++ b/openapi/ghe-2.16/operations/projects/add-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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.16/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", + "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.16/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.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.16/operations/projects/create-card.json b/openapi/ghe-2.16/operations/projects/create-card.json index 02b83d83b8..11e54ba68d 100644 --- a/openapi/ghe-2.16/operations/projects/create-card.json +++ b/openapi/ghe-2.16/operations/projects/create-card.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -156,16 +156,16 @@ "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" + "type": "string", + "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`." }, "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.16/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.16/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" + "type": "integer", + "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.16/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.16/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`." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.16/operations/projects/create-column.json b/openapi/ghe-2.16/operations/projects/create-column.json index 4bc02ee013..42f23c29db 100644 --- a/openapi/ghe-2.16/operations/projects/create-column.json +++ b/openapi/ghe-2.16/operations/projects/create-column.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The name of the column.", - "type": "string" + "type": "string", + "description": "The name of the column." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/projects/create-for-org.json b/openapi/ghe-2.16/operations/projects/create-for-org.json index 195fb0f1c6..370fce9cac 100644 --- a/openapi/ghe-2.16/operations/projects/create-for-org.json +++ b/openapi/ghe-2.16/operations/projects/create-for-org.json @@ -22,32 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,12 +180,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/projects/create-for-repo.json b/openapi/ghe-2.16/operations/projects/create-for-repo.json index 7bb63114b2..c590d84657 100644 --- a/openapi/ghe-2.16/operations/projects/create-for-repo.json +++ b/openapi/ghe-2.16/operations/projects/create-for-repo.json @@ -22,41 +22,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -191,12 +189,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/projects/delete-card.json b/openapi/ghe-2.16/operations/projects/delete-card.json index 90e45636f8..33941915b8 100644 --- a/openapi/ghe-2.16/operations/projects/delete-card.json +++ b/openapi/ghe-2.16/operations/projects/delete-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/delete-column.json b/openapi/ghe-2.16/operations/projects/delete-column.json index f20785231a..028d2c3871 100644 --- a/openapi/ghe-2.16/operations/projects/delete-column.json +++ b/openapi/ghe-2.16/operations/projects/delete-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/delete.json b/openapi/ghe-2.16/operations/projects/delete.json index f93e352634..83d1132465 100644 --- a/openapi/ghe-2.16/operations/projects/delete.json +++ b/openapi/ghe-2.16/operations/projects/delete.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/get-card.json b/openapi/ghe-2.16/operations/projects/get-card.json index c8888811f4..8088e329ca 100644 --- a/openapi/ghe-2.16/operations/projects/get-card.json +++ b/openapi/ghe-2.16/operations/projects/get-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/get-column.json b/openapi/ghe-2.16/operations/projects/get-column.json index 8408cf4129..f09dc946aa 100644 --- a/openapi/ghe-2.16/operations/projects/get-column.json +++ b/openapi/ghe-2.16/operations/projects/get-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/get.json b/openapi/ghe-2.16/operations/projects/get.json index 48e7e4a50e..a964de988a 100644 --- a/openapi/ghe-2.16/operations/projects/get.json +++ b/openapi/ghe-2.16/operations/projects/get.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/list-cards.json b/openapi/ghe-2.16/operations/projects/list-cards.json index 243170e729..cb9377e6e0 100644 --- a/openapi/ghe-2.16/operations/projects/list-cards.json +++ b/openapi/ghe-2.16/operations/projects/list-cards.json @@ -22,16 +22,18 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } }, { "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "not_archived" ], "default": "not_archived" - }, - "required": false, - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/list-collaborators.json b/openapi/ghe-2.16/operations/projects/list-collaborators.json index f413126719..6e45b70932 100644 --- a/openapi/ghe-2.16/operations/projects/list-collaborators.json +++ b/openapi/ghe-2.16/operations/projects/list-collaborators.json @@ -22,16 +22,18 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/list-columns.json b/openapi/ghe-2.16/operations/projects/list-columns.json index f643ad9971..c0ebada491 100644 --- a/openapi/ghe-2.16/operations/projects/list-columns.json +++ b/openapi/ghe-2.16/operations/projects/list-columns.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/list-for-org.json b/openapi/ghe-2.16/operations/projects/list-for-org.json index ff9db49712..79e74ee7d9 100644 --- a/openapi/ghe-2.16/operations/projects/list-for-org.json +++ b/openapi/ghe-2.16/operations/projects/list-for-org.json @@ -22,16 +22,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/list-for-repo.json b/openapi/ghe-2.16/operations/projects/list-for-repo.json index 071fbd7114..f10c88badc 100644 --- a/openapi/ghe-2.16/operations/projects/list-for-repo.json +++ b/openapi/ghe-2.16/operations/projects/list-for-repo.json @@ -22,25 +22,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -49,29 +51,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/move-card.json b/openapi/ghe-2.16/operations/projects/move-card.json index 530d998972..ae1e131114 100644 --- a/openapi/ghe-2.16/operations/projects/move-card.json +++ b/openapi/ghe-2.16/operations/projects/move-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,13 +58,13 @@ "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", + "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`.", "pattern": "^(top|bottom|after:\\d+)$" }, "column_id": { - "description": "The `id` value of a column in the same project.", - "type": "integer" + "type": "integer", + "description": "The `id` value of a column in the same project." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/projects/move-column.json b/openapi/ghe-2.16/operations/projects/move-column.json index 5640c3acf7..0211891e72 100644 --- a/openapi/ghe-2.16/operations/projects/move-column.json +++ b/openapi/ghe-2.16/operations/projects/move-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "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", + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", "pattern": "^(first|last|after:\\d+)$" } }, diff --git a/openapi/ghe-2.16/operations/projects/remove-collaborator.json b/openapi/ghe-2.16/operations/projects/remove-collaborator.json index 0e9dfbc3ec..6089a41bef 100644 --- a/openapi/ghe-2.16/operations/projects/remove-collaborator.json +++ b/openapi/ghe-2.16/operations/projects/remove-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/review-user-permission-level.json b/openapi/ghe-2.16/operations/projects/review-user-permission-level.json index 92f918d1a5..9bc116c137 100644 --- a/openapi/ghe-2.16/operations/projects/review-user-permission-level.json +++ b/openapi/ghe-2.16/operations/projects/review-user-permission-level.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/projects/update-card.json b/openapi/ghe-2.16/operations/projects/update-card.json index 82a0790d4f..b3c0d80ccf 100644 --- a/openapi/ghe-2.16/operations/projects/update-card.json +++ b/openapi/ghe-2.16/operations/projects/update-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,12 +58,12 @@ "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" + "type": "string", + "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`." }, "archived": { - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "type": "boolean" + "type": "boolean", + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card." } } } diff --git a/openapi/ghe-2.16/operations/projects/update-column.json b/openapi/ghe-2.16/operations/projects/update-column.json index 9649bf0141..082e05c16c 100644 --- a/openapi/ghe-2.16/operations/projects/update-column.json +++ b/openapi/ghe-2.16/operations/projects/update-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The new name of the column.", - "type": "string" + "type": "string", + "description": "The new name of the column." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/projects/update.json b/openapi/ghe-2.16/operations/projects/update.json index fa68a747e2..fb7a683a5c 100644 --- a/openapi/ghe-2.16/operations/projects/update.json +++ b/openapi/ghe-2.16/operations/projects/update.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,28 +180,28 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." }, "state": { - "description": "State of the project. Either `open` or `closed`.", "type": "string", + "description": "State of the project. Either `open` or `closed`.", "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.16/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.16/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" + "type": "string", + "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.16/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.16/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." }, "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" + "type": "boolean", + "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." } } } diff --git a/openapi/ghe-2.16/operations/pulls/check-if-merged.json b/openapi/ghe-2.16/operations/pulls/check-if-merged.json index 6456205005..12494409ed 100644 --- a/openapi/ghe-2.16/operations/pulls/check-if-merged.json +++ b/openapi/ghe-2.16/operations/pulls/check-if-merged.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/create-comment-reply.json b/openapi/ghe-2.16/operations/pulls/create-comment-reply.json index df79db1694..d7e53e7ebe 100644 --- a/openapi/ghe-2.16/operations/pulls/create-comment-reply.json +++ b/openapi/ghe-2.16/operations/pulls/create-comment-reply.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,12 +231,12 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/create-comment.json b/openapi/ghe-2.16/operations/pulls/create-comment.json index 5a8f9e6186..40c094dc8e 100644 --- a/openapi/ghe-2.16/operations/pulls/create-comment.json +++ b/openapi/ghe-2.16/operations/pulls/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,20 +231,20 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "string", + "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`." }, "path": { - "description": "The relative path to the file that necessitates a comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/create-from-issue.json b/openapi/ghe-2.16/operations/pulls/create-from-issue.json index 57eb76c564..072d0b56d0 100644 --- a/openapi/ghe-2.16/operations/pulls/create-from-issue.json +++ b/openapi/ghe-2.16/operations/pulls/create-from-issue.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1502,20 +1502,20 @@ "type": "object", "properties": { "issue": { - "description": "The issue number in this repository to turn into a Pull Request.", - "type": "integer" + "type": "integer", + "description": "The issue number in this repository to turn into a Pull Request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/create-review-request.json b/openapi/ghe-2.16/operations/pulls/create-review-request.json index fb91ac8b84..6486447b90 100644 --- a/openapi/ghe-2.16/operations/pulls/create-review-request.json +++ b/openapi/ghe-2.16/operations/pulls/create-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1449,15 +1449,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be requested.", "type": "array", + "description": "An array of user `login`s that will be requested.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be requested.", "type": "array", + "description": "An array of team `slug`s that will be requested.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/pulls/create-review.json b/openapi/ghe-2.16/operations/pulls/create-review.json index 104cd10d3a..fa47d870d5 100644 --- a/openapi/ghe-2.16/operations/pulls/create-review.json +++ b/openapi/ghe-2.16/operations/pulls/create-review.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -196,16 +196,16 @@ "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" + "type": "string", + "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." }, "body": { - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "type": "string" + "type": "string", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." }, "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.16/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "type": "string", + "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.16/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -213,22 +213,22 @@ ] }, "comments": { - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "type": "array", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "items": { "type": "object", "properties": { "path": { - "description": "The relative path to the file that necessitates a review comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a review comment." }, "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" + "type": "integer", + "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." }, "body": { - "description": "Text of the review comment.", - "type": "string" + "type": "string", + "description": "Text of the review comment." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/create.json b/openapi/ghe-2.16/operations/pulls/create.json index a0ba361e57..87578d9f7b 100644 --- a/openapi/ghe-2.16/operations/pulls/create.json +++ b/openapi/ghe-2.16/operations/pulls/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1502,24 +1502,24 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "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" + "type": "boolean", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/delete-comment.json b/openapi/ghe-2.16/operations/pulls/delete-comment.json index 988d26bf03..f5f21be3ee 100644 --- a/openapi/ghe-2.16/operations/pulls/delete-comment.json +++ b/openapi/ghe-2.16/operations/pulls/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/delete-pending-review.json b/openapi/ghe-2.16/operations/pulls/delete-pending-review.json index 23ced40a0e..b64b823dcf 100644 --- a/openapi/ghe-2.16/operations/pulls/delete-pending-review.json +++ b/openapi/ghe-2.16/operations/pulls/delete-pending-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/delete-review-request.json b/openapi/ghe-2.16/operations/pulls/delete-review-request.json index df2a0d6476..45f8420fa1 100644 --- a/openapi/ghe-2.16/operations/pulls/delete-review-request.json +++ b/openapi/ghe-2.16/operations/pulls/delete-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -85,15 +85,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be removed.", "type": "array", + "description": "An array of user `login`s that will be removed.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be removed.", "type": "array", + "description": "An array of team `slug`s that will be removed.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/pulls/dismiss-review.json b/openapi/ghe-2.16/operations/pulls/dismiss-review.json index 672ed9847c..4c7e2ccd2a 100644 --- a/openapi/ghe-2.16/operations/pulls/dismiss-review.json +++ b/openapi/ghe-2.16/operations/pulls/dismiss-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,8 +204,8 @@ "type": "object", "properties": { "message": { - "description": "The message for the pull request review dismissal", - "type": "string" + "type": "string", + "description": "The message for the pull request review dismissal" } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/get-comment.json b/openapi/ghe-2.16/operations/pulls/get-comment.json index 4a5b3ea934..cf1c1dda53 100644 --- a/openapi/ghe-2.16/operations/pulls/get-comment.json +++ b/openapi/ghe-2.16/operations/pulls/get-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/get-comments-for-review.json b/openapi/ghe-2.16/operations/pulls/get-comments-for-review.json index 6b385cfbac..f942c6f38a 100644 --- a/openapi/ghe-2.16/operations/pulls/get-comments-for-review.json +++ b/openapi/ghe-2.16/operations/pulls/get-comments-for-review.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/get-review.json b/openapi/ghe-2.16/operations/pulls/get-review.json index e02eb0a82d..b9ad56c41c 100644 --- a/openapi/ghe-2.16/operations/pulls/get-review.json +++ b/openapi/ghe-2.16/operations/pulls/get-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/get.json b/openapi/ghe-2.16/operations/pulls/get.json index fa4dfcc662..1f66ebf0f5 100644 --- a/openapi/ghe-2.16/operations/pulls/get.json +++ b/openapi/ghe-2.16/operations/pulls/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list-comments-for-repo.json b/openapi/ghe-2.16/operations/pulls/list-comments-for-repo.json index 05bbfd30a8..de9705660f 100644 --- a/openapi/ghe-2.16/operations/pulls/list-comments-for-repo.json +++ b/openapi/ghe-2.16/operations/pulls/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,51 +49,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list-comments.json b/openapi/ghe-2.16/operations/pulls/list-comments.json index 29106ec67c..fe0095b186 100644 --- a/openapi/ghe-2.16/operations/pulls/list-comments.json +++ b/openapi/ghe-2.16/operations/pulls/list-comments.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,51 +58,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list-commits.json b/openapi/ghe-2.16/operations/pulls/list-commits.json index 4d58ad3026..9ae29335a5 100644 --- a/openapi/ghe-2.16/operations/pulls/list-commits.json +++ b/openapi/ghe-2.16/operations/pulls/list-commits.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list-files.json b/openapi/ghe-2.16/operations/pulls/list-files.json index 2e3c30f83f..f32542ea5a 100644 --- a/openapi/ghe-2.16/operations/pulls/list-files.json +++ b/openapi/ghe-2.16/operations/pulls/list-files.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list-review-requests.json b/openapi/ghe-2.16/operations/pulls/list-review-requests.json index 6793741f4d..35e3b34f90 100644 --- a/openapi/ghe-2.16/operations/pulls/list-review-requests.json +++ b/openapi/ghe-2.16/operations/pulls/list-review-requests.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list-reviews.json b/openapi/ghe-2.16/operations/pulls/list-reviews.json index 495be8bb44..bf29b85ca4 100644 --- a/openapi/ghe-2.16/operations/pulls/list-reviews.json +++ b/openapi/ghe-2.16/operations/pulls/list-reviews.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/list.json b/openapi/ghe-2.16/operations/pulls/list.json index b8687e6535..01778be64b 100644 --- a/openapi/ghe-2.16/operations/pulls/list.json +++ b/openapi/ghe-2.16/operations/pulls/list.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,31 +50,31 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Either `open`, `closed`, or `all` to filter by state." + } }, { "name": "head", + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", "in": "query", + "required": false, "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", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter pulls by base branch name. Example: `gh-pages`." + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -82,42 +84,38 @@ "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", + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/pulls/merge.json b/openapi/ghe-2.16/operations/pulls/merge.json index cd790a27ad..6480f9032b 100644 --- a/openapi/ghe-2.16/operations/pulls/merge.json +++ b/openapi/ghe-2.16/operations/pulls/merge.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -86,20 +86,20 @@ "type": "object", "properties": { "commit_title": { - "description": "Title for the automatic commit message.", - "type": "string" + "type": "string", + "description": "Title for the automatic commit message." }, "commit_message": { - "description": "Extra detail to append to automatic commit message.", - "type": "string" + "type": "string", + "description": "Extra detail to append to automatic commit message." }, "sha": { - "description": "SHA that pull request head must match to allow merge.", - "type": "string" + "type": "string", + "description": "SHA that pull request head must match to allow merge." }, "merge_method": { - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "type": "string", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "enum": [ "merge", "squash", diff --git a/openapi/ghe-2.16/operations/pulls/submit-review.json b/openapi/ghe-2.16/operations/pulls/submit-review.json index 62ae01a4c6..1f6d905eb9 100644 --- a/openapi/ghe-2.16/operations/pulls/submit-review.json +++ b/openapi/ghe-2.16/operations/pulls/submit-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,12 +204,12 @@ "type": "object", "properties": { "body": { - "description": "The body text of the pull request review", - "type": "string" + "type": "string", + "description": "The body text of the pull request review" }, "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", + "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.", "enum": [ "APPROVE", "REQUEST_CHANGES", diff --git a/openapi/ghe-2.16/operations/pulls/update-comment.json b/openapi/ghe-2.16/operations/pulls/update-comment.json index f002e9be26..286aa5463a 100644 --- a/openapi/ghe-2.16/operations/pulls/update-comment.json +++ b/openapi/ghe-2.16/operations/pulls/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -220,8 +220,8 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/pulls/update.json b/openapi/ghe-2.16/operations/pulls/update.json index ef56ca2a66..bd9afe1793 100644 --- a/openapi/ghe-2.16/operations/pulls/update.json +++ b/openapi/ghe-2.16/operations/pulls/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1520,28 +1520,28 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", + "description": "State of this Pull Request. Either `open` or `closed`.", "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." } } } diff --git a/openapi/ghe-2.16/operations/reactions/create-for-commit-comment.json b/openapi/ghe-2.16/operations/reactions/create-for-commit-comment.json index db80213428..24c6129961 100644 --- a/openapi/ghe-2.16/operations/reactions/create-for-commit-comment.json +++ b/openapi/ghe-2.16/operations/reactions/create-for-commit-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the commit comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the commit comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.16/operations/reactions/create-for-issue-comment.json b/openapi/ghe-2.16/operations/reactions/create-for-issue-comment.json index 94ce73cfa7..ef924589fa 100644 --- a/openapi/ghe-2.16/operations/reactions/create-for-issue-comment.json +++ b/openapi/ghe-2.16/operations/reactions/create-for-issue-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the issue comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the issue comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.16/operations/reactions/create-for-issue.json b/openapi/ghe-2.16/operations/reactions/create-for-issue.json index ec810b6cf7..4b65e38c68 100644 --- a/openapi/ghe-2.16/operations/reactions/create-for-issue.json +++ b/openapi/ghe-2.16/operations/reactions/create-for-issue.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -166,8 +166,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the issue.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the issue.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.16/operations/reactions/create-for-pull-request-review-comment.json b/openapi/ghe-2.16/operations/reactions/create-for-pull-request-review-comment.json index 036e4b394d..2fe2cb80ac 100644 --- a/openapi/ghe-2.16/operations/reactions/create-for-pull-request-review-comment.json +++ b/openapi/ghe-2.16/operations/reactions/create-for-pull-request-review-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the pull request review comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the pull request review comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.16/operations/reactions/create-for-team-discussion-comment.json b/openapi/ghe-2.16/operations/reactions/create-for-team-discussion-comment.json index d5d644daf5..17fa9e0159 100644 --- a/openapi/ghe-2.16/operations/reactions/create-for-team-discussion-comment.json +++ b/openapi/ghe-2.16/operations/reactions/create-for-team-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the team discussion comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the team discussion comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.16/operations/reactions/create-for-team-discussion.json b/openapi/ghe-2.16/operations/reactions/create-for-team-discussion.json index 186cff16d2..3770ec00dd 100644 --- a/openapi/ghe-2.16/operations/reactions/create-for-team-discussion.json +++ b/openapi/ghe-2.16/operations/reactions/create-for-team-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -147,8 +147,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the team discussion.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types) to add to the team discussion.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.16/operations/reactions/delete.json b/openapi/ghe-2.16/operations/reactions/delete.json index b41575dad8..4ca349c65b 100644 --- a/openapi/ghe-2.16/operations/reactions/delete.json +++ b/openapi/ghe-2.16/operations/reactions/delete.json @@ -22,12 +22,12 @@ }, { "name": "reaction_id", + "description": "reaction_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "reaction_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/reactions/list-for-commit-comment.json b/openapi/ghe-2.16/operations/reactions/list-for-commit-comment.json index 4b1ed22b9c..19214eb054 100644 --- a/openapi/ghe-2.16/operations/reactions/list-for-commit-comment.json +++ b/openapi/ghe-2.16/operations/reactions/list-for-commit-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/reactions/list-for-issue-comment.json b/openapi/ghe-2.16/operations/reactions/list-for-issue-comment.json index ef2980394b..d29cf8096c 100644 --- a/openapi/ghe-2.16/operations/reactions/list-for-issue-comment.json +++ b/openapi/ghe-2.16/operations/reactions/list-for-issue-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/reactions/list-for-issue.json b/openapi/ghe-2.16/operations/reactions/list-for-issue.json index b6fde79b1e..61f5fe82a9 100644 --- a/openapi/ghe-2.16/operations/reactions/list-for-issue.json +++ b/openapi/ghe-2.16/operations/reactions/list-for-issue.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/reactions/list-for-pull-request-review-comment.json b/openapi/ghe-2.16/operations/reactions/list-for-pull-request-review-comment.json index 82affcade9..d93768f24c 100644 --- a/openapi/ghe-2.16/operations/reactions/list-for-pull-request-review-comment.json +++ b/openapi/ghe-2.16/operations/reactions/list-for-pull-request-review-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/reactions/list-for-team-discussion-comment.json b/openapi/ghe-2.16/operations/reactions/list-for-team-discussion-comment.json index 38ed84297d..d9bf8afc1d 100644 --- a/openapi/ghe-2.16/operations/reactions/list-for-team-discussion-comment.json +++ b/openapi/ghe-2.16/operations/reactions/list-for-team-discussion-comment.json @@ -22,34 +22,36 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/reactions/list-for-team-discussion.json b/openapi/ghe-2.16/operations/reactions/list-for-team-discussion.json index 0870c800ed..3e6cf2cf7e 100644 --- a/openapi/ghe-2.16/operations/reactions/list-for-team-discussion.json +++ b/openapi/ghe-2.16/operations/reactions/list-for-team-discussion.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.16/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/accept-invitation.json b/openapi/ghe-2.16/operations/repos/accept-invitation.json index c156d7398b..b14b934ff5 100644 --- a/openapi/ghe-2.16/operations/repos/accept-invitation.json +++ b/openapi/ghe-2.16/operations/repos/accept-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/add-collaborator.json b/openapi/ghe-2.16/operations/repos/add-collaborator.json index 8e6df027ed..9e5bc64ae7 100644 --- a/openapi/ghe-2.16/operations/repos/add-collaborator.json +++ b/openapi/ghe-2.16/operations/repos/add-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -76,8 +76,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/ghe-2.16/operations/repos/add-deploy-key.json b/openapi/ghe-2.16/operations/repos/add-deploy-key.json index c95f968558..e6cc6476d7 100644 --- a/openapi/ghe-2.16/operations/repos/add-deploy-key.json +++ b/openapi/ghe-2.16/operations/repos/add-deploy-key.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "type": "object", "properties": { "title": { - "description": "A name for the key.", - "type": "string" + "type": "string", + "description": "A name for the key." }, "key": { - "description": "The contents of the key.", - "type": "string" + "type": "string", + "description": "The contents of the key." }, "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" + "type": "boolean", + "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/).\"" } }, "required": [ diff --git a/openapi/ghe-2.16/operations/repos/add-protected-branch-admin-enforcement.json b/openapi/ghe-2.16/operations/repos/add-protected-branch-admin-enforcement.json index c1fc07308d..50d6274714 100644 --- a/openapi/ghe-2.16/operations/repos/add-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.16/operations/repos/add-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/add-protected-branch-required-signatures.json b/openapi/ghe-2.16/operations/repos/add-protected-branch-required-signatures.json index d159002945..a95e3d5709 100644 --- a/openapi/ghe-2.16/operations/repos/add-protected-branch-required-signatures.json +++ b/openapi/ghe-2.16/operations/repos/add-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/add-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.16/operations/repos/add-protected-branch-required-status-checks-contexts.json index 3557a0e6ab..50d5c170cb 100644 --- a/openapi/ghe-2.16/operations/repos/add-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.16/operations/repos/add-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/add-protected-branch-team-restrictions.json b/openapi/ghe-2.16/operations/repos/add-protected-branch-team-restrictions.json index 518d0f76f4..32a8135745 100644 --- a/openapi/ghe-2.16/operations/repos/add-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/add-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/add-protected-branch-user-restrictions.json b/openapi/ghe-2.16/operations/repos/add-protected-branch-user-restrictions.json index 42b525e982..49b922e63c 100644 --- a/openapi/ghe-2.16/operations/repos/add-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/add-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/check-collaborator.json b/openapi/ghe-2.16/operations/repos/check-collaborator.json index 29546506e3..fda15e5c96 100644 --- a/openapi/ghe-2.16/operations/repos/check-collaborator.json +++ b/openapi/ghe-2.16/operations/repos/check-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/compare-commits.json b/openapi/ghe-2.16/operations/repos/compare-commits.json index b5392e0b69..eb22adbbd1 100644 --- a/openapi/ghe-2.16/operations/repos/compare-commits.json +++ b/openapi/ghe-2.16/operations/repos/compare-commits.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "base", + "description": "base parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "base parameter" + } }, { "name": "head", + "description": "head parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "head parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/create-commit-comment.json b/openapi/ghe-2.16/operations/repos/create-commit-comment.json index dcf3ea60a3..8c0393f6f8 100644 --- a/openapi/ghe-2.16/operations/repos/create-commit-comment.json +++ b/openapi/ghe-2.16/operations/repos/create-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { @@ -187,20 +187,20 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." }, "path": { - "description": "Relative path of the file to comment on.", - "type": "string" + "type": "string", + "description": "Relative path of the file to comment on." }, "position": { - "description": "Line index in the diff to comment on.", - "type": "integer" + "type": "integer", + "description": "Line index in the diff to comment on." }, "line": { - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "type": "integer" + "type": "integer", + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/repos/create-deployment-status.json b/openapi/ghe-2.16/operations/repos/create-deployment-status.json index 8765ff372b..8b28f0ed54 100644 --- a/openapi/ghe-2.16/operations/repos/create-deployment-status.json +++ b/openapi/ghe-2.16/operations/repos/create-deployment-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { @@ -182,8 +182,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type.", "enum": [ "error", "failure", @@ -195,23 +195,23 @@ ] }, "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", + "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": "" }, "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", + "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": "" }, "description": { - "description": "A short description of the status. The maximum description length is 140 characters.", "type": "string", + "description": "A short description of the status. The maximum description length is 140 characters.", "default": "" }, "environment": { - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type.", "type": "string", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type.", "enum": [ "production", "staging", @@ -219,13 +219,13 @@ ] }, "environment_url": { - "description": "Sets the URL for accessing your environment.", "type": "string", + "description": "Sets the URL for accessing your environment.", "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. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type. **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type.", "type": "boolean", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type. **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.16/v3/previews/#deployment-statuses) custom media type.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/repos/create-deployment.json b/openapi/ghe-2.16/operations/repos/create-deployment.json index e953fad2c9..0e3981276b 100644 --- a/openapi/ghe-2.16/operations/repos/create-deployment.json +++ b/openapi/ghe-2.16/operations/repos/create-deployment.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,49 +66,49 @@ "type": "object", "properties": { "ref": { - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "type": "string" + "type": "string", + "description": "The ref to deploy. This can be a branch, tag, or SHA." }, "task": { - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "type": "string", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "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", + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", "default": true }, "required_contexts": { - "description": "The [status](https://developer.github.com/enterprise/2.16/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", + "description": "The [status](https://developer.github.com/enterprise/2.16/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.", "items": { "type": "string" } }, "payload": { - "description": "JSON payload with extra information about the deployment.", "type": "string", + "description": "JSON payload with extra information about the deployment.", "default": "" }, "environment": { - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "type": "string", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "default": "production" }, "description": { - "description": "Short description of the deployment.", "type": "string", + "description": "Short description of the deployment.", "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", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.", "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" + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/repos/create-for-authenticated-user.json b/openapi/ghe-2.16/operations/repos/create-for-authenticated-user.json index 3f860c3ad2..f5f4ee16a3 100644 --- a/openapi/ghe-2.16/operations/repos/create-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/repos/create-for-authenticated-user.json @@ -355,67 +355,67 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/repos/create-fork.json b/openapi/ghe-2.16/operations/repos/create-fork.json index 4de85dfde6..8bc8469be4 100644 --- a/openapi/ghe-2.16/operations/repos/create-fork.json +++ b/openapi/ghe-2.16/operations/repos/create-fork.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -373,8 +373,8 @@ "type": "object", "properties": { "organization": { - "description": "Optional parameter to specify the organization name if forking into an organization.", - "type": "string" + "type": "string", + "description": "Optional parameter to specify the organization name if forking into an organization." } } } diff --git a/openapi/ghe-2.16/operations/repos/create-hook.json b/openapi/ghe-2.16/operations/repos/create-hook.json index 1129770460..c3ba6c355a 100644 --- a/openapi/ghe-2.16/operations/repos/create-hook.json +++ b/openapi/ghe-2.16/operations/repos/create-hook.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -136,29 +136,29 @@ "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.16/v3/guides/replacing-github-services) for details.", "type": "string", + "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.16/v3/guides/replacing-github-services) for details.", "default": "web" }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.16/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.16/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -166,8 +166,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -176,8 +176,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/repos/create-in-org.json b/openapi/ghe-2.16/operations/repos/create-in-org.json index d8a0e5d03f..ff16adecd1 100644 --- a/openapi/ghe-2.16/operations/repos/create-in-org.json +++ b/openapi/ghe-2.16/operations/repos/create-in-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -364,67 +364,67 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/ghe-2.16/operations/repos/create-or-update-file.json b/openapi/ghe-2.16/operations/repos/create-or-update-file.json index 685d373161..de1b94a381 100644 --- a/openapi/ghe-2.16/operations/repos/create-or-update-file.json +++ b/openapi/ghe-2.16/operations/repos/create-or-update-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -250,32 +250,32 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "content": { - "description": "The new file content, using Base64 encoding.", - "type": "string" + "type": "string", + "description": "The new file content, using Base64 encoding." }, "sha": { - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "The person that committed the file. Default: the authenticated user.", "type": "object", + "description": "The person that committed the file. Default: the authenticated user.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ @@ -284,16 +284,16 @@ ] }, "author": { - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "type": "object", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/repos/create-release.json b/openapi/ghe-2.16/operations/repos/create-release.json index 8f3c08b47f..6a9cb1520a 100644 --- a/openapi/ghe-2.16/operations/repos/create-release.json +++ b/openapi/ghe-2.16/operations/repos/create-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -187,29 +187,29 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "type": "boolean", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "default": false }, "prerelease": { - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "type": "boolean", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "default": false } }, diff --git a/openapi/ghe-2.16/operations/repos/create-status.json b/openapi/ghe-2.16/operations/repos/create-status.json index ea97aa6a7b..129621bfe9 100644 --- a/openapi/ghe-2.16/operations/repos/create-status.json +++ b/openapi/ghe-2.16/operations/repos/create-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { @@ -173,8 +173,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "enum": [ "error", "failure", @@ -183,16 +183,16 @@ ] }, "target_url": { - "description": "The target URL to associate with this status. This URL will be linked from the GitHub Enterprise Server 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" + "type": "string", + "description": "The target URL to associate with this status. This URL will be linked from the GitHub Enterprise Server 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`" }, "description": { - "description": "A short description of the status.", - "type": "string" + "type": "string", + "description": "A short description of the status." }, "context": { - "description": "A string label to differentiate this status from the status of other systems.", "type": "string", + "description": "A string label to differentiate this status from the status of other systems.", "default": "default" } }, diff --git a/openapi/ghe-2.16/operations/repos/decline-invitation.json b/openapi/ghe-2.16/operations/repos/decline-invitation.json index 36496aaae5..c6ccdd7abd 100644 --- a/openapi/ghe-2.16/operations/repos/decline-invitation.json +++ b/openapi/ghe-2.16/operations/repos/decline-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete-commit-comment.json b/openapi/ghe-2.16/operations/repos/delete-commit-comment.json index 6cd35b3d3f..e67c58c566 100644 --- a/openapi/ghe-2.16/operations/repos/delete-commit-comment.json +++ b/openapi/ghe-2.16/operations/repos/delete-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete-download.json b/openapi/ghe-2.16/operations/repos/delete-download.json index 66a993cd73..4e8c7dcaa3 100644 --- a/openapi/ghe-2.16/operations/repos/delete-download.json +++ b/openapi/ghe-2.16/operations/repos/delete-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete-file.json b/openapi/ghe-2.16/operations/repos/delete-file.json index f45d2c2328..7def6a36b7 100644 --- a/openapi/ghe-2.16/operations/repos/delete-file.json +++ b/openapi/ghe-2.16/operations/repos/delete-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -180,42 +180,42 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "sha": { - "description": "The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "object containing information about the committer.", "type": "object", + "description": "object containing information about the committer.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } }, "author": { - "description": "object containing information about the author.", "type": "object", + "description": "object containing information about the author.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } } diff --git a/openapi/ghe-2.16/operations/repos/delete-hook.json b/openapi/ghe-2.16/operations/repos/delete-hook.json index bb44400513..80af7882e6 100644 --- a/openapi/ghe-2.16/operations/repos/delete-hook.json +++ b/openapi/ghe-2.16/operations/repos/delete-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete-invitation.json b/openapi/ghe-2.16/operations/repos/delete-invitation.json index fa31fd53c7..5b39041936 100644 --- a/openapi/ghe-2.16/operations/repos/delete-invitation.json +++ b/openapi/ghe-2.16/operations/repos/delete-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete-release-asset.json b/openapi/ghe-2.16/operations/repos/delete-release-asset.json index 05fb4caa76..6f4b2a9b3d 100644 --- a/openapi/ghe-2.16/operations/repos/delete-release-asset.json +++ b/openapi/ghe-2.16/operations/repos/delete-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete-release.json b/openapi/ghe-2.16/operations/repos/delete-release.json index fa89b40bfa..1bc38485cf 100644 --- a/openapi/ghe-2.16/operations/repos/delete-release.json +++ b/openapi/ghe-2.16/operations/repos/delete-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/delete.json b/openapi/ghe-2.16/operations/repos/delete.json index 377497450a..dd8aa5816f 100644 --- a/openapi/ghe-2.16/operations/repos/delete.json +++ b/openapi/ghe-2.16/operations/repos/delete.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-archive-link.json b/openapi/ghe-2.16/operations/repos/get-archive-link.json index 0f349c9da2..c116e43f17 100644 --- a/openapi/ghe-2.16/operations/repos/get-archive-link.json +++ b/openapi/ghe-2.16/operations/repos/get-archive-link.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "archive_format", + "description": "archive_format parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "archive_format parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-branch-protection.json b/openapi/ghe-2.16/operations/repos/get-branch-protection.json index f42340a3bc..b63a090ed2 100644 --- a/openapi/ghe-2.16/operations/repos/get-branch-protection.json +++ b/openapi/ghe-2.16/operations/repos/get-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-branch.json b/openapi/ghe-2.16/operations/repos/get-branch.json index f09c527b64..cad8655ba0 100644 --- a/openapi/ghe-2.16/operations/repos/get-branch.json +++ b/openapi/ghe-2.16/operations/repos/get-branch.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-code-frequency-stats.json b/openapi/ghe-2.16/operations/repos/get-code-frequency-stats.json index 7227bc260f..c58b7f0351 100644 --- a/openapi/ghe-2.16/operations/repos/get-code-frequency-stats.json +++ b/openapi/ghe-2.16/operations/repos/get-code-frequency-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-collaborator-permission-level.json b/openapi/ghe-2.16/operations/repos/get-collaborator-permission-level.json index 78e163ea0c..3f35f19050 100644 --- a/openapi/ghe-2.16/operations/repos/get-collaborator-permission-level.json +++ b/openapi/ghe-2.16/operations/repos/get-collaborator-permission-level.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-combined-status-for-ref.json b/openapi/ghe-2.16/operations/repos/get-combined-status-for-ref.json index 65784b3ca3..8c94843599 100644 --- a/openapi/ghe-2.16/operations/repos/get-combined-status-for-ref.json +++ b/openapi/ghe-2.16/operations/repos/get-combined-status-for-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-commit-activity-stats.json b/openapi/ghe-2.16/operations/repos/get-commit-activity-stats.json index df0845d9db..851ddf06c0 100644 --- a/openapi/ghe-2.16/operations/repos/get-commit-activity-stats.json +++ b/openapi/ghe-2.16/operations/repos/get-commit-activity-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-commit-comment.json b/openapi/ghe-2.16/operations/repos/get-commit-comment.json index a1dff6f3e5..6fada2a7d0 100644 --- a/openapi/ghe-2.16/operations/repos/get-commit-comment.json +++ b/openapi/ghe-2.16/operations/repos/get-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-commit.json b/openapi/ghe-2.16/operations/repos/get-commit.json index cace87b94d..39b494a736 100644 --- a/openapi/ghe-2.16/operations/repos/get-commit.json +++ b/openapi/ghe-2.16/operations/repos/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-contents.json b/openapi/ghe-2.16/operations/repos/get-contents.json index 66cb216137..9c74c94814 100644 --- a/openapi/ghe-2.16/operations/repos/get-contents.json +++ b/openapi/ghe-2.16/operations/repos/get-contents.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-contributors-stats.json b/openapi/ghe-2.16/operations/repos/get-contributors-stats.json index c28fec10ad..2b009288f2 100644 --- a/openapi/ghe-2.16/operations/repos/get-contributors-stats.json +++ b/openapi/ghe-2.16/operations/repos/get-contributors-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-deploy-key.json b/openapi/ghe-2.16/operations/repos/get-deploy-key.json index c1a0dcadd9..ab7edaa01f 100644 --- a/openapi/ghe-2.16/operations/repos/get-deploy-key.json +++ b/openapi/ghe-2.16/operations/repos/get-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-deployment-status.json b/openapi/ghe-2.16/operations/repos/get-deployment-status.json index 5fe6460c48..b517eedc3c 100644 --- a/openapi/ghe-2.16/operations/repos/get-deployment-status.json +++ b/openapi/ghe-2.16/operations/repos/get-deployment-status.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "status_id", + "description": "status_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "status_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-deployment.json b/openapi/ghe-2.16/operations/repos/get-deployment.json index 8d73cbded9..50fb3acee9 100644 --- a/openapi/ghe-2.16/operations/repos/get-deployment.json +++ b/openapi/ghe-2.16/operations/repos/get-deployment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-download.json b/openapi/ghe-2.16/operations/repos/get-download.json index 9c95b7159b..23fd8fa59c 100644 --- a/openapi/ghe-2.16/operations/repos/get-download.json +++ b/openapi/ghe-2.16/operations/repos/get-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-hook.json b/openapi/ghe-2.16/operations/repos/get-hook.json index cb6294ce8d..71d4842314 100644 --- a/openapi/ghe-2.16/operations/repos/get-hook.json +++ b/openapi/ghe-2.16/operations/repos/get-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-latest-pages-build.json b/openapi/ghe-2.16/operations/repos/get-latest-pages-build.json index 57d9000da2..025c316772 100644 --- a/openapi/ghe-2.16/operations/repos/get-latest-pages-build.json +++ b/openapi/ghe-2.16/operations/repos/get-latest-pages-build.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-latest-release.json b/openapi/ghe-2.16/operations/repos/get-latest-release.json index 8a85508b51..a7ef358fa5 100644 --- a/openapi/ghe-2.16/operations/repos/get-latest-release.json +++ b/openapi/ghe-2.16/operations/repos/get-latest-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-pages-build.json b/openapi/ghe-2.16/operations/repos/get-pages-build.json index 2f2a7a4db9..4bebfdc14a 100644 --- a/openapi/ghe-2.16/operations/repos/get-pages-build.json +++ b/openapi/ghe-2.16/operations/repos/get-pages-build.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "build_id", + "description": "build_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "build_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-pages.json b/openapi/ghe-2.16/operations/repos/get-pages.json index cec4afee71..7a7a17efd1 100644 --- a/openapi/ghe-2.16/operations/repos/get-pages.json +++ b/openapi/ghe-2.16/operations/repos/get-pages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-participation-stats.json b/openapi/ghe-2.16/operations/repos/get-participation-stats.json index ae87bf0b71..70e41ff3c3 100644 --- a/openapi/ghe-2.16/operations/repos/get-participation-stats.json +++ b/openapi/ghe-2.16/operations/repos/get-participation-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-protected-branch-admin-enforcement.json b/openapi/ghe-2.16/operations/repos/get-protected-branch-admin-enforcement.json index 98a5743a1a..959392cdef 100644 --- a/openapi/ghe-2.16/operations/repos/get-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.16/operations/repos/get-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.16/operations/repos/get-protected-branch-pull-request-review-enforcement.json index ca36d89097..9d38a79eb3 100644 --- a/openapi/ghe-2.16/operations/repos/get-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.16/operations/repos/get-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-protected-branch-required-signatures.json b/openapi/ghe-2.16/operations/repos/get-protected-branch-required-signatures.json index 8a402c56fd..5dd97d5cad 100644 --- a/openapi/ghe-2.16/operations/repos/get-protected-branch-required-signatures.json +++ b/openapi/ghe-2.16/operations/repos/get-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-protected-branch-required-status-checks.json b/openapi/ghe-2.16/operations/repos/get-protected-branch-required-status-checks.json index 00f8f5f6ee..67c4c3c53b 100644 --- a/openapi/ghe-2.16/operations/repos/get-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.16/operations/repos/get-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-protected-branch-restrictions.json b/openapi/ghe-2.16/operations/repos/get-protected-branch-restrictions.json index 9f40445492..839d1da200 100644 --- a/openapi/ghe-2.16/operations/repos/get-protected-branch-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/get-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-punch-card-stats.json b/openapi/ghe-2.16/operations/repos/get-punch-card-stats.json index 28565dd8e9..a74a9b4916 100644 --- a/openapi/ghe-2.16/operations/repos/get-punch-card-stats.json +++ b/openapi/ghe-2.16/operations/repos/get-punch-card-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-readme.json b/openapi/ghe-2.16/operations/repos/get-readme.json index e661481a7e..2a8591571e 100644 --- a/openapi/ghe-2.16/operations/repos/get-readme.json +++ b/openapi/ghe-2.16/operations/repos/get-readme.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-release-asset.json b/openapi/ghe-2.16/operations/repos/get-release-asset.json index 3768fc56c2..1810934414 100644 --- a/openapi/ghe-2.16/operations/repos/get-release-asset.json +++ b/openapi/ghe-2.16/operations/repos/get-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-release-by-tag.json b/openapi/ghe-2.16/operations/repos/get-release-by-tag.json index 65f3f3d57e..a57fff5598 100644 --- a/openapi/ghe-2.16/operations/repos/get-release-by-tag.json +++ b/openapi/ghe-2.16/operations/repos/get-release-by-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag", + "description": "tag parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get-release.json b/openapi/ghe-2.16/operations/repos/get-release.json index 62863f768f..b50ca24fed 100644 --- a/openapi/ghe-2.16/operations/repos/get-release.json +++ b/openapi/ghe-2.16/operations/repos/get-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/get.json b/openapi/ghe-2.16/operations/repos/get.json index 23242dad59..38a60880fe 100644 --- a/openapi/ghe-2.16/operations/repos/get.json +++ b/openapi/ghe-2.16/operations/repos/get.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-assets-for-release.json b/openapi/ghe-2.16/operations/repos/list-assets-for-release.json index d4398c39f6..e61bb8cd48 100644 --- a/openapi/ghe-2.16/operations/repos/list-assets-for-release.json +++ b/openapi/ghe-2.16/operations/repos/list-assets-for-release.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-branches.json b/openapi/ghe-2.16/operations/repos/list-branches.json index 44edc23a4b..58e458a08f 100644 --- a/openapi/ghe-2.16/operations/repos/list-branches.json +++ b/openapi/ghe-2.16/operations/repos/list-branches.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "protected", + "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.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-collaborators.json b/openapi/ghe-2.16/operations/repos/list-collaborators.json index cb17268ebc..9ffbaf14e9 100644 --- a/openapi/ghe-2.16/operations/repos/list-collaborators.json +++ b/openapi/ghe-2.16/operations/repos/list-collaborators.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-comments-for-commit.json b/openapi/ghe-2.16/operations/repos/list-comments-for-commit.json index aaaf211025..c0409d73a9 100644 --- a/openapi/ghe-2.16/operations/repos/list-comments-for-commit.json +++ b/openapi/ghe-2.16/operations/repos/list-comments-for-commit.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-commit-comments.json b/openapi/ghe-2.16/operations/repos/list-commit-comments.json index 6bf5d11e31..552237dcee 100644 --- a/openapi/ghe-2.16/operations/repos/list-commit-comments.json +++ b/openapi/ghe-2.16/operations/repos/list-commit-comments.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-commits.json b/openapi/ghe-2.16/operations/repos/list-commits.json index 2982af39bf..b7c17e7e92 100644 --- a/openapi/ghe-2.16/operations/repos/list-commits.json +++ b/openapi/ghe-2.16/operations/repos/list-commits.json @@ -21,86 +21,84 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`)." + } }, { "name": "path", + "description": "Only commits containing this file path will be returned.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Only commits containing this file path will be returned." + } }, { "name": "author", + "description": "GitHub login or email address by which to filter by commit author.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "GitHub login or email address by which to filter by commit author." + } }, { "name": "since", + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-contributors.json b/openapi/ghe-2.16/operations/repos/list-contributors.json index 34a22ba21c..155ae09a5c 100644 --- a/openapi/ghe-2.16/operations/repos/list-contributors.json +++ b/openapi/ghe-2.16/operations/repos/list-contributors.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Set to `1` or `true` to include anonymous contributors in results." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-deploy-keys.json b/openapi/ghe-2.16/operations/repos/list-deploy-keys.json index 529116de61..5194b3d81d 100644 --- a/openapi/ghe-2.16/operations/repos/list-deploy-keys.json +++ b/openapi/ghe-2.16/operations/repos/list-deploy-keys.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-deployment-statuses.json b/openapi/ghe-2.16/operations/repos/list-deployment-statuses.json index 6ebeb2e7cc..3a704c20dd 100644 --- a/openapi/ghe-2.16/operations/repos/list-deployment-statuses.json +++ b/openapi/ghe-2.16/operations/repos/list-deployment-statuses.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-deployments.json b/openapi/ghe-2.16/operations/repos/list-deployments.json index 1bd5b619a2..348db2b6d7 100644 --- a/openapi/ghe-2.16/operations/repos/list-deployments.json +++ b/openapi/ghe-2.16/operations/repos/list-deployments.json @@ -21,81 +21,79 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "The SHA recorded at creation time.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The SHA recorded at creation time." + } }, { "name": "ref", + "description": "The name of the ref. This can be a branch, tag, or SHA.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the ref. This can be a branch, tag, or SHA." + } }, { "name": "task", + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`)." + } }, { "name": "environment", + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-downloads.json b/openapi/ghe-2.16/operations/repos/list-downloads.json index 2a9b9150f1..a3170dc50c 100644 --- a/openapi/ghe-2.16/operations/repos/list-downloads.json +++ b/openapi/ghe-2.16/operations/repos/list-downloads.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-for-org.json b/openapi/ghe-2.16/operations/repos/list-for-org.json index 2e81f992dd..9fdde2fc0b 100644 --- a/openapi/ghe-2.16/operations/repos/list-for-org.json +++ b/openapi/ghe-2.16/operations/repos/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -42,29 +44,25 @@ "member" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-for-user.json b/openapi/ghe-2.16/operations/repos/list-for-user.json index 925101656c..79088d150c 100644 --- a/openapi/ghe-2.16/operations/repos/list-for-user.json +++ b/openapi/ghe-2.16/operations/repos/list-for-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `owner`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "member" ], "default": "owner" - }, - "required": false, - "description": "Can be one of `all`, `owner`, `member`." + } }, { "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -55,42 +57,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-forks.json b/openapi/ghe-2.16/operations/repos/list-forks.json index f6d6d90e25..09fac584a8 100644 --- a/openapi/ghe-2.16/operations/repos/list-forks.json +++ b/openapi/ghe-2.16/operations/repos/list-forks.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "stargazers" ], "default": "newest" - }, - "required": false, - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-hooks.json b/openapi/ghe-2.16/operations/repos/list-hooks.json index fc2ebb3618..eccbbc5493 100644 --- a/openapi/ghe-2.16/operations/repos/list-hooks.json +++ b/openapi/ghe-2.16/operations/repos/list-hooks.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-invitations-for-authenticated-user.json b/openapi/ghe-2.16/operations/repos/list-invitations-for-authenticated-user.json index b26a4048bd..6c346175f0 100644 --- a/openapi/ghe-2.16/operations/repos/list-invitations-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/repos/list-invitations-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-invitations.json b/openapi/ghe-2.16/operations/repos/list-invitations.json index 4dd65daf2f..1afaa4710d 100644 --- a/openapi/ghe-2.16/operations/repos/list-invitations.json +++ b/openapi/ghe-2.16/operations/repos/list-invitations.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-languages.json b/openapi/ghe-2.16/operations/repos/list-languages.json index 065da97540..c7940109ba 100644 --- a/openapi/ghe-2.16/operations/repos/list-languages.json +++ b/openapi/ghe-2.16/operations/repos/list-languages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-pages-builds.json b/openapi/ghe-2.16/operations/repos/list-pages-builds.json index 4ccc8ee981..16dbb7b0e2 100644 --- a/openapi/ghe-2.16/operations/repos/list-pages-builds.json +++ b/openapi/ghe-2.16/operations/repos/list-pages-builds.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.16/operations/repos/list-protected-branch-required-status-checks-contexts.json index 1a0fd46c11..8234afcdd9 100644 --- a/openapi/ghe-2.16/operations/repos/list-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.16/operations/repos/list-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-protected-branch-team-restrictions.json b/openapi/ghe-2.16/operations/repos/list-protected-branch-team-restrictions.json index 1bc69bb307..77c2f505d3 100644 --- a/openapi/ghe-2.16/operations/repos/list-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/list-protected-branch-team-restrictions.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-protected-branch-user-restrictions.json b/openapi/ghe-2.16/operations/repos/list-protected-branch-user-restrictions.json index a1acca1f47..c5fab4187b 100644 --- a/openapi/ghe-2.16/operations/repos/list-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/list-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-public.json b/openapi/ghe-2.16/operations/repos/list-public.json index 4b9658bdd0..cd764088bb 100644 --- a/openapi/ghe-2.16/operations/repos/list-public.json +++ b/openapi/ghe-2.16/operations/repos/list-public.json @@ -21,42 +21,40 @@ }, { "name": "since", + "description": "The integer ID of the last Repository that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Repository that you've seen." + } }, { "name": "visibility", + "description": "To include private repositories as well set to `all`.", "in": "query", + "required": false, "schema": { "type": "string", "default": "public" - }, - "required": false, - "description": "To include private repositories as well set to `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-releases.json b/openapi/ghe-2.16/operations/repos/list-releases.json index 7fb8ac4a66..3db9ba243e 100644 --- a/openapi/ghe-2.16/operations/repos/list-releases.json +++ b/openapi/ghe-2.16/operations/repos/list-releases.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-statuses-for-ref.json b/openapi/ghe-2.16/operations/repos/list-statuses-for-ref.json index 8278597d09..42836cfecc 100644 --- a/openapi/ghe-2.16/operations/repos/list-statuses-for-ref.json +++ b/openapi/ghe-2.16/operations/repos/list-statuses-for-ref.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-tags.json b/openapi/ghe-2.16/operations/repos/list-tags.json index af47b3ac47..b91aff567f 100644 --- a/openapi/ghe-2.16/operations/repos/list-tags.json +++ b/openapi/ghe-2.16/operations/repos/list-tags.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-teams.json b/openapi/ghe-2.16/operations/repos/list-teams.json index ceff68349f..df76bada15 100644 --- a/openapi/ghe-2.16/operations/repos/list-teams.json +++ b/openapi/ghe-2.16/operations/repos/list-teams.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list-topics.json b/openapi/ghe-2.16/operations/repos/list-topics.json index 1d92395e9c..1aea9dd93c 100644 --- a/openapi/ghe-2.16/operations/repos/list-topics.json +++ b/openapi/ghe-2.16/operations/repos/list-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/list.json b/openapi/ghe-2.16/operations/repos/list.json index f7ba11dbe6..9dfd24d2e4 100644 --- a/openapi/ghe-2.16/operations/repos/list.json +++ b/openapi/ghe-2.16/operations/repos/list.json @@ -21,7 +21,9 @@ }, { "name": "visibility", + "description": "Can be one of `all`, `public`, or `private`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -30,23 +32,23 @@ "private" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, or `private`." + } }, { "name": "affiliation", + "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.", "in": "query", + "required": false, "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", + "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**.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,13 +59,13 @@ "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", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -73,42 +75,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/merge.json b/openapi/ghe-2.16/operations/repos/merge.json index 939e0ae22e..72a82a091a 100644 --- a/openapi/ghe-2.16/operations/repos/merge.json +++ b/openapi/ghe-2.16/operations/repos/merge.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,16 +66,16 @@ "type": "object", "properties": { "base": { - "description": "The name of the base branch that the head will be merged into.", - "type": "string" + "type": "string", + "description": "The name of the base branch that the head will be merged into." }, "head": { - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "type": "string" + "type": "string", + "description": "The head to merge. This can be a branch name or a commit SHA1." }, "commit_message": { - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "type": "string" + "type": "string", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/repos/ping-hook.json b/openapi/ghe-2.16/operations/repos/ping-hook.json index 29a4c2dca7..8e668c870f 100644 --- a/openapi/ghe-2.16/operations/repos/ping-hook.json +++ b/openapi/ghe-2.16/operations/repos/ping-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-branch-protection.json b/openapi/ghe-2.16/operations/repos/remove-branch-protection.json index 2ab36a920e..b3c296896b 100644 --- a/openapi/ghe-2.16/operations/repos/remove-branch-protection.json +++ b/openapi/ghe-2.16/operations/repos/remove-branch-protection.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-collaborator.json b/openapi/ghe-2.16/operations/repos/remove-collaborator.json index 1f2d1378ef..6a5993338a 100644 --- a/openapi/ghe-2.16/operations/repos/remove-collaborator.json +++ b/openapi/ghe-2.16/operations/repos/remove-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-deploy-key.json b/openapi/ghe-2.16/operations/repos/remove-deploy-key.json index 546abc2aee..f576db0fbe 100644 --- a/openapi/ghe-2.16/operations/repos/remove-deploy-key.json +++ b/openapi/ghe-2.16/operations/repos/remove-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-admin-enforcement.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-admin-enforcement.json index d758e63412..46ee892ee6 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-pull-request-review-enforcement.json index a57169e254..d53ba4c5b9 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-pull-request-review-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-signatures.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-signatures.json index 24a4bfc50a..f0cd125aef 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-signatures.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks-contexts.json index eea04d075f..a875250da4 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks.json index 89a5056f93..3ec879c1f8 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-restrictions.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-restrictions.json index 1f0b32912d..38f59fb8cf 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-team-restrictions.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-team-restrictions.json index fc7de7d07c..4ac6272a26 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/remove-protected-branch-user-restrictions.json b/openapi/ghe-2.16/operations/repos/remove-protected-branch-user-restrictions.json index 66aa3a12ea..22c07784d9 100644 --- a/openapi/ghe-2.16/operations/repos/remove-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/remove-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/replace-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.16/operations/repos/replace-protected-branch-required-status-checks-contexts.json index 1880d40cef..0fdb23fa55 100644 --- a/openapi/ghe-2.16/operations/repos/replace-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.16/operations/repos/replace-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/replace-protected-branch-team-restrictions.json b/openapi/ghe-2.16/operations/repos/replace-protected-branch-team-restrictions.json index e1db5c8521..7f0bc0b8ba 100644 --- a/openapi/ghe-2.16/operations/repos/replace-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/replace-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/replace-protected-branch-user-restrictions.json b/openapi/ghe-2.16/operations/repos/replace-protected-branch-user-restrictions.json index 16de7dcb0c..6790849881 100644 --- a/openapi/ghe-2.16/operations/repos/replace-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.16/operations/repos/replace-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.16/operations/repos/replace-topics.json b/openapi/ghe-2.16/operations/repos/replace-topics.json index 7e573fa10f..34d8f57115 100644 --- a/openapi/ghe-2.16/operations/repos/replace-topics.json +++ b/openapi/ghe-2.16/operations/repos/replace-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,8 +81,8 @@ "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", + "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.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/repos/request-page-build.json b/openapi/ghe-2.16/operations/repos/request-page-build.json index a47d531f2e..59f802730e 100644 --- a/openapi/ghe-2.16/operations/repos/request-page-build.json +++ b/openapi/ghe-2.16/operations/repos/request-page-build.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/test-push-hook.json b/openapi/ghe-2.16/operations/repos/test-push-hook.json index f23786ba69..ee44c9d524 100644 --- a/openapi/ghe-2.16/operations/repos/test-push-hook.json +++ b/openapi/ghe-2.16/operations/repos/test-push-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/repos/transfer.json b/openapi/ghe-2.16/operations/repos/transfer.json index 3652697026..d4123b3b11 100644 --- a/openapi/ghe-2.16/operations/repos/transfer.json +++ b/openapi/ghe-2.16/operations/repos/transfer.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -374,12 +374,12 @@ "type": "object", "properties": { "new_owner": { - "description": "**Required:** The username or organization name the repository will be transferred to.", - "type": "string" + "type": "string", + "description": "**Required:** The username or organization name the repository will be transferred to." }, "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", + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", "items": { "type": "integer" } diff --git a/openapi/ghe-2.16/operations/repos/update-branch-protection.json b/openapi/ghe-2.16/operations/repos/update-branch-protection.json index cbc2a87d87..ff88119d08 100644 --- a/openapi/ghe-2.16/operations/repos/update-branch-protection.json +++ b/openapi/ghe-2.16/operations/repos/update-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -370,17 +370,17 @@ "type": "object", "properties": { "required_status_checks": { - "description": "Require status checks to pass before merging. Set to `null` to disable.", "type": "object", + "description": "Require status checks to pass before merging. Set to `null` to disable.", "nullable": true, "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } @@ -392,29 +392,29 @@ ] }, "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", + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", "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", + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -422,34 +422,34 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them." }, "required_approving_review_count": { - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } }, "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", + "description": "Restrict who can push to this branch. Team and user `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "nullable": true, "properties": { "users": { - "description": "The list of user `login`s with push access", "type": "array", + "description": "The list of user `login`s with push access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with push access", "type": "array", + "description": "The list of team `slug`s with push access", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/repos/update-commit-comment.json b/openapi/ghe-2.16/operations/repos/update-commit-comment.json index 74fbd0aba3..ee480905c5 100644 --- a/openapi/ghe-2.16/operations/repos/update-commit-comment.json +++ b/openapi/ghe-2.16/operations/repos/update-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -176,8 +176,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment", - "type": "string" + "type": "string", + "description": "The contents of the comment" } }, "required": [ diff --git a/openapi/ghe-2.16/operations/repos/update-hook.json b/openapi/ghe-2.16/operations/repos/update-hook.json index 1c54e1e433..fc2e269a16 100644 --- a/openapi/ghe-2.16/operations/repos/update-hook.json +++ b/openapi/ghe-2.16/operations/repos/update-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -145,24 +145,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.16/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.16/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.16/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -170,8 +170,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.16/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -180,22 +180,22 @@ } }, "add_events": { - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "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", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.16/operations/repos/update-information-about-pages-site.json b/openapi/ghe-2.16/operations/repos/update-information-about-pages-site.json index 099f4f685a..0ca7fc68ed 100644 --- a/openapi/ghe-2.16/operations/repos/update-information-about-pages-site.json +++ b/openapi/ghe-2.16/operations/repos/update-information-about-pages-site.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "type": "object", "properties": { "source": { - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "type": "string", + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "enum": [ "\"gh-pages\"", "\"master\"", diff --git a/openapi/ghe-2.16/operations/repos/update-invitation.json b/openapi/ghe-2.16/operations/repos/update-invitation.json index 995f5981be..12d9ebe83c 100644 --- a/openapi/ghe-2.16/operations/repos/update-invitation.json +++ b/openapi/ghe-2.16/operations/repos/update-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { @@ -419,8 +419,8 @@ "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", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.16/operations/repos/update-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.16/operations/repos/update-protected-branch-pull-request-review-enforcement.json index ba5bfa89e8..ad552aae69 100644 --- a/openapi/ghe-2.16/operations/repos/update-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.16/operations/repos/update-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -214,19 +214,19 @@ "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -234,16 +234,16 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } } diff --git a/openapi/ghe-2.16/operations/repos/update-protected-branch-required-status-checks.json b/openapi/ghe-2.16/operations/repos/update-protected-branch-required-status-checks.json index 612771716b..72c1fdd552 100644 --- a/openapi/ghe-2.16/operations/repos/update-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.16/operations/repos/update-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -99,12 +99,12 @@ "type": "object", "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/repos/update-release-asset.json b/openapi/ghe-2.16/operations/repos/update-release-asset.json index dd7a640144..732508b2d4 100644 --- a/openapi/ghe-2.16/operations/repos/update-release-asset.json +++ b/openapi/ghe-2.16/operations/repos/update-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "name": { - "description": "The file name of the asset.", - "type": "string" + "type": "string", + "description": "The file name of the asset." }, "label": { - "description": "An alternate short description of the asset. Used in place of the filename.", - "type": "string" + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename." } } } diff --git a/openapi/ghe-2.16/operations/repos/update-release.json b/openapi/ghe-2.16/operations/repos/update-release.json index f50cef75a9..7bb15df5e4 100644 --- a/openapi/ghe-2.16/operations/repos/update-release.json +++ b/openapi/ghe-2.16/operations/repos/update-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { @@ -294,28 +294,28 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` makes the release a draft, and `false` publishes the release.", - "type": "boolean" + "type": "boolean", + "description": "`true` makes the release a draft, and `false` publishes the release." }, "prerelease": { - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "type": "boolean" + "type": "boolean", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release." } } } diff --git a/openapi/ghe-2.16/operations/repos/update.json b/openapi/ghe-2.16/operations/repos/update.json index 47c3ac02e4..673b4a017b 100644 --- a/openapi/ghe-2.16/operations/repos/update.json +++ b/openapi/ghe-2.16/operations/repos/update.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1036,64 +1036,64 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "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.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "default": true }, "default_branch": { - "description": "Updates the default branch for this repository.", - "type": "string" + "type": "string", + "description": "Updates the default branch for this repository." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true }, "archived": { - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "type": "boolean", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "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 Server instances that have private mode enabled.", "type": "boolean", + "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 Server instances that have private mode enabled.", "default": false } }, diff --git a/openapi/ghe-2.16/operations/search/code.json b/openapi/ghe-2.16/operations/search/code.json index f86bd73ca2..54172aa200 100644 --- a/openapi/ghe-2.16/operations/search/code.json +++ b/openapi/ghe-2.16/operations/search/code.json @@ -21,28 +21,30 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.16/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.16/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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 Server search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.16/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -50,29 +52,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/commits.json b/openapi/ghe-2.16/operations/search/commits.json index a9d0618251..74ba3d5742 100644 --- a/openapi/ghe-2.16/operations/search/commits.json +++ b/openapi/ghe-2.16/operations/search/commits.json @@ -22,29 +22,31 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.16/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.16/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.16/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/email-legacy.json b/openapi/ghe-2.16/operations/search/email-legacy.json index 3be2aa6fe3..bae32d73d5 100644 --- a/openapi/ghe-2.16/operations/search/email-legacy.json +++ b/openapi/ghe-2.16/operations/search/email-legacy.json @@ -21,12 +21,12 @@ }, { "name": "email", + "description": "The email address.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The email address." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/issues-and-pull-requests.json b/openapi/ghe-2.16/operations/search/issues-and-pull-requests.json index cfc0ef7b56..d0f58ab97a 100644 --- a/openapi/ghe-2.16/operations/search/issues-and-pull-requests.json +++ b/openapi/ghe-2.16/operations/search/issues-and-pull-requests.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.16/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", + "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.16/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -46,13 +48,13 @@ "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.16/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,29 +62,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/issues-legacy.json b/openapi/ghe-2.16/operations/search/issues-legacy.json index e987c51190..20b6f68ecc 100644 --- a/openapi/ghe-2.16/operations/search/issues-legacy.json +++ b/openapi/ghe-2.16/operations/search/issues-legacy.json @@ -21,43 +21,43 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repository", + "description": "repository parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repository parameter" + } }, { "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", "in": "path", + "required": true, "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", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/labels.json b/openapi/ghe-2.16/operations/search/labels.json index 6f6dbb8ea5..2ecdfda799 100644 --- a/openapi/ghe-2.16/operations/search/labels.json +++ b/openapi/ghe-2.16/operations/search/labels.json @@ -21,38 +21,40 @@ }, { "name": "repository_id", + "description": "The id of the repository.", "in": "query", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "The id of the repository." + } }, { "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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.16/v3/search/#constructing-a-search-query)." + } }, { "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.16/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.16/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,9 +62,7 @@ "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": { diff --git a/openapi/ghe-2.16/operations/search/repos-legacy.json b/openapi/ghe-2.16/operations/search/repos-legacy.json index 6bbc3dd0eb..b9fdf1c0ac 100644 --- a/openapi/ghe-2.16/operations/search/repos-legacy.json +++ b/openapi/ghe-2.16/operations/search/repos-legacy.json @@ -21,34 +21,36 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "language", + "description": "Filter results by language.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter results by language." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/repos.json b/openapi/ghe-2.16/operations/search/repos.json index f72821d1d3..80b56a4751 100644 --- a/openapi/ghe-2.16/operations/search/repos.json +++ b/openapi/ghe-2.16/operations/search/repos.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.16/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", + "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.16/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "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.16/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/topics.json b/openapi/ghe-2.16/operations/search/topics.json index 8010c3cb73..11f5589755 100644 --- a/openapi/ghe-2.16/operations/search/topics.json +++ b/openapi/ghe-2.16/operations/search/topics.json @@ -21,12 +21,12 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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.16/v3/search/#constructing-a-search-query)." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/users-legacy.json b/openapi/ghe-2.16/operations/search/users-legacy.json index 48a228762d..2ddcd1566b 100644 --- a/openapi/ghe-2.16/operations/search/users-legacy.json +++ b/openapi/ghe-2.16/operations/search/users-legacy.json @@ -21,25 +21,27 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/search/users.json b/openapi/ghe-2.16/operations/search/users.json index ed624eb648..27bba94f3b 100644 --- a/openapi/ghe-2.16/operations/search/users.json +++ b/openapi/ghe-2.16/operations/search/users.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.16/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.16/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://developer.github.com/enterprise/2.16/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "repositories", "joined" ] - }, - "required": false, - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://developer.github.com/enterprise/2.16/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/add-member.json b/openapi/ghe-2.16/operations/teams/add-member.json index 025961c5ef..e094dac2d4 100644 --- a/openapi/ghe-2.16/operations/teams/add-member.json +++ b/openapi/ghe-2.16/operations/teams/add-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/add-or-update-membership.json b/openapi/ghe-2.16/operations/teams/add-or-update-membership.json index 6495ed6460..083d30da11 100644 --- a/openapi/ghe-2.16/operations/teams/add-or-update-membership.json +++ b/openapi/ghe-2.16/operations/teams/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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", + "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.", "enum": [ "member", "maintainer" diff --git a/openapi/ghe-2.16/operations/teams/add-or-update-project.json b/openapi/ghe-2.16/operations/teams/add-or-update-project.json index e490623c39..80fa61908e 100644 --- a/openapi/ghe-2.16/operations/teams/add-or-update-project.json +++ b/openapi/ghe-2.16/operations/teams/add-or-update-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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.16/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", + "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.16/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.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.16/operations/teams/add-or-update-repo.json b/openapi/ghe-2.16/operations/teams/add-or-update-repo.json index 8afbccd7bb..7ba2f21b20 100644 --- a/openapi/ghe-2.16/operations/teams/add-or-update-repo.json +++ b/openapi/ghe-2.16/operations/teams/add-or-update-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -75,8 +75,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/ghe-2.16/operations/teams/check-manages-repo.json b/openapi/ghe-2.16/operations/teams/check-manages-repo.json index 647bb49531..0261a74e18 100644 --- a/openapi/ghe-2.16/operations/teams/check-manages-repo.json +++ b/openapi/ghe-2.16/operations/teams/check-manages-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/create-discussion-comment.json b/openapi/ghe-2.16/operations/teams/create-discussion-comment.json index a8b65d24d3..33f8d28dd2 100644 --- a/openapi/ghe-2.16/operations/teams/create-discussion-comment.json +++ b/openapi/ghe-2.16/operations/teams/create-discussion-comment.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -198,8 +198,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/teams/create-discussion.json b/openapi/ghe-2.16/operations/teams/create-discussion.json index 5e48a18fb4..6836908ea0 100644 --- a/openapi/ghe-2.16/operations/teams/create-discussion.json +++ b/openapi/ghe-2.16/operations/teams/create-discussion.json @@ -22,12 +22,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -204,16 +204,16 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." }, "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.16/operations/teams/create.json b/openapi/ghe-2.16/operations/teams/create.json index a0534f5d8b..48f8c192e3 100644 --- a/openapi/ghe-2.16/operations/teams/create.json +++ b/openapi/ghe-2.16/operations/teams/create.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -197,38 +197,38 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "maintainers": { - "description": "The logins of organization members to add as maintainers of the team.", "type": "array", + "description": "The logins of organization members to add as maintainers of the team.", "items": { "type": "string" } }, "repo_names": { - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -237,12 +237,12 @@ "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" + "type": "integer", + "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." }, "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.16/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN.", - "type": "string" + "type": "string", + "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.16/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/teams/delete-discussion-comment.json b/openapi/ghe-2.16/operations/teams/delete-discussion-comment.json index 44b2ab5842..ae79874353 100644 --- a/openapi/ghe-2.16/operations/teams/delete-discussion-comment.json +++ b/openapi/ghe-2.16/operations/teams/delete-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/delete-discussion.json b/openapi/ghe-2.16/operations/teams/delete-discussion.json index 9486181509..242a9ecd55 100644 --- a/openapi/ghe-2.16/operations/teams/delete-discussion.json +++ b/openapi/ghe-2.16/operations/teams/delete-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/delete.json b/openapi/ghe-2.16/operations/teams/delete.json index e3b002150e..6f32c037cb 100644 --- a/openapi/ghe-2.16/operations/teams/delete.json +++ b/openapi/ghe-2.16/operations/teams/delete.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/get-discussion-comment.json b/openapi/ghe-2.16/operations/teams/get-discussion-comment.json index c4daa745bc..3a8876d926 100644 --- a/openapi/ghe-2.16/operations/teams/get-discussion-comment.json +++ b/openapi/ghe-2.16/operations/teams/get-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/get-discussion.json b/openapi/ghe-2.16/operations/teams/get-discussion.json index 6ee4156449..5bf94c053f 100644 --- a/openapi/ghe-2.16/operations/teams/get-discussion.json +++ b/openapi/ghe-2.16/operations/teams/get-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/get-member.json b/openapi/ghe-2.16/operations/teams/get-member.json index 8eb5dff2eb..cd4c68469a 100644 --- a/openapi/ghe-2.16/operations/teams/get-member.json +++ b/openapi/ghe-2.16/operations/teams/get-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/get-membership.json b/openapi/ghe-2.16/operations/teams/get-membership.json index abb376572f..7b105cc702 100644 --- a/openapi/ghe-2.16/operations/teams/get-membership.json +++ b/openapi/ghe-2.16/operations/teams/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/get.json b/openapi/ghe-2.16/operations/teams/get.json index 69a0e5d2c4..09036b3a36 100644 --- a/openapi/ghe-2.16/operations/teams/get.json +++ b/openapi/ghe-2.16/operations/teams/get.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-child.json b/openapi/ghe-2.16/operations/teams/list-child.json index 9d854efc79..b19347522a 100644 --- a/openapi/ghe-2.16/operations/teams/list-child.json +++ b/openapi/ghe-2.16/operations/teams/list-child.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-discussion-comments.json b/openapi/ghe-2.16/operations/teams/list-discussion-comments.json index 19d3fea5c4..cd03933353 100644 --- a/openapi/ghe-2.16/operations/teams/list-discussion-comments.json +++ b/openapi/ghe-2.16/operations/teams/list-discussion-comments.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-discussions.json b/openapi/ghe-2.16/operations/teams/list-discussions.json index d0fb838f85..0e34c537fb 100644 --- a/openapi/ghe-2.16/operations/teams/list-discussions.json +++ b/openapi/ghe-2.16/operations/teams/list-discussions.json @@ -22,16 +22,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-for-authenticated-user.json b/openapi/ghe-2.16/operations/teams/list-for-authenticated-user.json index 86e9b542a2..6aa615ce19 100644 --- a/openapi/ghe-2.16/operations/teams/list-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/teams/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-members.json b/openapi/ghe-2.16/operations/teams/list-members.json index d3db8210d1..56a3c92604 100644 --- a/openapi/ghe-2.16/operations/teams/list-members.json +++ b/openapi/ghe-2.16/operations/teams/list-members.json @@ -21,16 +21,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-projects.json b/openapi/ghe-2.16/operations/teams/list-projects.json index 8c6d4c1152..c98f462296 100644 --- a/openapi/ghe-2.16/operations/teams/list-projects.json +++ b/openapi/ghe-2.16/operations/teams/list-projects.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list-repos.json b/openapi/ghe-2.16/operations/teams/list-repos.json index 75ecac95ab..1a85f0076f 100644 --- a/openapi/ghe-2.16/operations/teams/list-repos.json +++ b/openapi/ghe-2.16/operations/teams/list-repos.json @@ -21,32 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/list.json b/openapi/ghe-2.16/operations/teams/list.json index 9aee1720b0..dfa55db1ec 100644 --- a/openapi/ghe-2.16/operations/teams/list.json +++ b/openapi/ghe-2.16/operations/teams/list.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/remove-member.json b/openapi/ghe-2.16/operations/teams/remove-member.json index 5fadae46b3..c4da2d7eca 100644 --- a/openapi/ghe-2.16/operations/teams/remove-member.json +++ b/openapi/ghe-2.16/operations/teams/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/remove-membership.json b/openapi/ghe-2.16/operations/teams/remove-membership.json index 0dd5466b05..79a200e609 100644 --- a/openapi/ghe-2.16/operations/teams/remove-membership.json +++ b/openapi/ghe-2.16/operations/teams/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/remove-project.json b/openapi/ghe-2.16/operations/teams/remove-project.json index 6394f09704..0952cd0a2f 100644 --- a/openapi/ghe-2.16/operations/teams/remove-project.json +++ b/openapi/ghe-2.16/operations/teams/remove-project.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/remove-repo.json b/openapi/ghe-2.16/operations/teams/remove-repo.json index a1143c00f0..7bc10ca811 100644 --- a/openapi/ghe-2.16/operations/teams/remove-repo.json +++ b/openapi/ghe-2.16/operations/teams/remove-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/review-project.json b/openapi/ghe-2.16/operations/teams/review-project.json index d135118227..52e8190d60 100644 --- a/openapi/ghe-2.16/operations/teams/review-project.json +++ b/openapi/ghe-2.16/operations/teams/review-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/teams/update-discussion-comment.json b/openapi/ghe-2.16/operations/teams/update-discussion-comment.json index c283d5f4f8..7a5bf0775f 100644 --- a/openapi/ghe-2.16/operations/teams/update-discussion-comment.json +++ b/openapi/ghe-2.16/operations/teams/update-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -206,8 +206,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/teams/update-discussion.json b/openapi/ghe-2.16/operations/teams/update-discussion.json index e65e58055f..9025dc10ef 100644 --- a/openapi/ghe-2.16/operations/teams/update-discussion.json +++ b/openapi/ghe-2.16/operations/teams/update-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -212,12 +212,12 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." } } } diff --git a/openapi/ghe-2.16/operations/teams/update.json b/openapi/ghe-2.16/operations/teams/update.json index 3bd5aa2ce3..c688fe87ce 100644 --- a/openapi/ghe-2.16/operations/teams/update.json +++ b/openapi/ghe-2.16/operations/teams/update.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -197,24 +197,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -223,8 +223,8 @@ "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.16/operations/users/add-emails.json b/openapi/ghe-2.16/operations/users/add-emails.json index 0530874f63..7b63d812b3 100644 --- a/openapi/ghe-2.16/operations/users/add-emails.json +++ b/openapi/ghe-2.16/operations/users/add-emails.json @@ -72,8 +72,8 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Adds one or more email addresses to your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/users/check-following-for-user.json b/openapi/ghe-2.16/operations/users/check-following-for-user.json index a867e13be6..29cc31a167 100644 --- a/openapi/ghe-2.16/operations/users/check-following-for-user.json +++ b/openapi/ghe-2.16/operations/users/check-following-for-user.json @@ -21,21 +21,21 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "target_user", + "description": "target_user parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "target_user parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/check-following.json b/openapi/ghe-2.16/operations/users/check-following.json index f68a2cf8f2..0cd10762e8 100644 --- a/openapi/ghe-2.16/operations/users/check-following.json +++ b/openapi/ghe-2.16/operations/users/check-following.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/create-gpg-key.json b/openapi/ghe-2.16/operations/users/create-gpg-key.json index 3ff9494e69..6b10fd2068 100644 --- a/openapi/ghe-2.16/operations/users/create-gpg-key.json +++ b/openapi/ghe-2.16/operations/users/create-gpg-key.json @@ -147,8 +147,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.16/operations/users/create-public-key.json b/openapi/ghe-2.16/operations/users/create-public-key.json index a5c4a0f524..68c5cf9995 100644 --- a/openapi/ghe-2.16/operations/users/create-public-key.json +++ b/openapi/ghe-2.16/operations/users/create-public-key.json @@ -78,12 +78,12 @@ "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.16/operations/users/delete-emails.json b/openapi/ghe-2.16/operations/users/delete-emails.json index c021113106..31ec1b096f 100644 --- a/openapi/ghe-2.16/operations/users/delete-emails.json +++ b/openapi/ghe-2.16/operations/users/delete-emails.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "emails": { - "description": "Deletes one or more email addresses from your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Deletes one or more email addresses from your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.16/operations/users/delete-gpg-key.json b/openapi/ghe-2.16/operations/users/delete-gpg-key.json index 27c7fd80c5..b4e0ab7dca 100644 --- a/openapi/ghe-2.16/operations/users/delete-gpg-key.json +++ b/openapi/ghe-2.16/operations/users/delete-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/delete-public-key.json b/openapi/ghe-2.16/operations/users/delete-public-key.json index c44d25015d..07696c47df 100644 --- a/openapi/ghe-2.16/operations/users/delete-public-key.json +++ b/openapi/ghe-2.16/operations/users/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/follow.json b/openapi/ghe-2.16/operations/users/follow.json index 6705d13e66..9a4355bae7 100644 --- a/openapi/ghe-2.16/operations/users/follow.json +++ b/openapi/ghe-2.16/operations/users/follow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/get-by-username.json b/openapi/ghe-2.16/operations/users/get-by-username.json index c175f41686..7108a3e92c 100644 --- a/openapi/ghe-2.16/operations/users/get-by-username.json +++ b/openapi/ghe-2.16/operations/users/get-by-username.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/get-context-for-user.json b/openapi/ghe-2.16/operations/users/get-context-for-user.json index b6cbaa62b1..f8a6c12c36 100644 --- a/openapi/ghe-2.16/operations/users/get-context-for-user.json +++ b/openapi/ghe-2.16/operations/users/get-context-for-user.json @@ -22,16 +22,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "subject_type", + "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`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,18 +42,16 @@ "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", + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/get-gpg-key.json b/openapi/ghe-2.16/operations/users/get-gpg-key.json index 0545d0cb84..7f457a5eb1 100644 --- a/openapi/ghe-2.16/operations/users/get-gpg-key.json +++ b/openapi/ghe-2.16/operations/users/get-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/get-public-key.json b/openapi/ghe-2.16/operations/users/get-public-key.json index a7df01a84d..6f42ebf8a9 100644 --- a/openapi/ghe-2.16/operations/users/get-public-key.json +++ b/openapi/ghe-2.16/operations/users/get-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-emails.json b/openapi/ghe-2.16/operations/users/list-emails.json index 515167b767..e5a5c4f633 100644 --- a/openapi/ghe-2.16/operations/users/list-emails.json +++ b/openapi/ghe-2.16/operations/users/list-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-followers-for-authenticated-user.json b/openapi/ghe-2.16/operations/users/list-followers-for-authenticated-user.json index df8f924c5e..83e39cc343 100644 --- a/openapi/ghe-2.16/operations/users/list-followers-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/users/list-followers-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-followers-for-user.json b/openapi/ghe-2.16/operations/users/list-followers-for-user.json index 23e04405e4..b7579e21ef 100644 --- a/openapi/ghe-2.16/operations/users/list-followers-for-user.json +++ b/openapi/ghe-2.16/operations/users/list-followers-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-following-for-authenticated-user.json b/openapi/ghe-2.16/operations/users/list-following-for-authenticated-user.json index de6ebda45b..cf7317bdc3 100644 --- a/openapi/ghe-2.16/operations/users/list-following-for-authenticated-user.json +++ b/openapi/ghe-2.16/operations/users/list-following-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-following-for-user.json b/openapi/ghe-2.16/operations/users/list-following-for-user.json index 38eaddef5d..9f466a1db9 100644 --- a/openapi/ghe-2.16/operations/users/list-following-for-user.json +++ b/openapi/ghe-2.16/operations/users/list-following-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-gpg-keys-for-user.json b/openapi/ghe-2.16/operations/users/list-gpg-keys-for-user.json index f52e5478c5..8fbbdf8abd 100644 --- a/openapi/ghe-2.16/operations/users/list-gpg-keys-for-user.json +++ b/openapi/ghe-2.16/operations/users/list-gpg-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-gpg-keys.json b/openapi/ghe-2.16/operations/users/list-gpg-keys.json index 6c90f1606f..07bbb5a1f1 100644 --- a/openapi/ghe-2.16/operations/users/list-gpg-keys.json +++ b/openapi/ghe-2.16/operations/users/list-gpg-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-public-emails.json b/openapi/ghe-2.16/operations/users/list-public-emails.json index ae0bf931a9..9dc3e6d3cc 100644 --- a/openapi/ghe-2.16/operations/users/list-public-emails.json +++ b/openapi/ghe-2.16/operations/users/list-public-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-public-keys-for-user.json b/openapi/ghe-2.16/operations/users/list-public-keys-for-user.json index 5ab0e1be3a..4da735d2a0 100644 --- a/openapi/ghe-2.16/operations/users/list-public-keys-for-user.json +++ b/openapi/ghe-2.16/operations/users/list-public-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list-public-keys.json b/openapi/ghe-2.16/operations/users/list-public-keys.json index 14413a6a02..fbe65805d1 100644 --- a/openapi/ghe-2.16/operations/users/list-public-keys.json +++ b/openapi/ghe-2.16/operations/users/list-public-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/list.json b/openapi/ghe-2.16/operations/users/list.json index ce48c19d9c..15bf3ce247 100644 --- a/openapi/ghe-2.16/operations/users/list.json +++ b/openapi/ghe-2.16/operations/users/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last User that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last User that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/unfollow.json b/openapi/ghe-2.16/operations/users/unfollow.json index 7064f23e7e..c26c3406eb 100644 --- a/openapi/ghe-2.16/operations/users/unfollow.json +++ b/openapi/ghe-2.16/operations/users/unfollow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.16/operations/users/update-authenticated.json b/openapi/ghe-2.16/operations/users/update-authenticated.json index c7728ccbf7..4fe0fff534 100644 --- a/openapi/ghe-2.16/operations/users/update-authenticated.json +++ b/openapi/ghe-2.16/operations/users/update-authenticated.json @@ -188,32 +188,32 @@ "type": "object", "properties": { "name": { - "description": "The new name of the user.", - "type": "string" + "type": "string", + "description": "The new name of the user." }, "email": { - "description": "The publicly visible email address of the user.", - "type": "string" + "type": "string", + "description": "The publicly visible email address of the user." }, "blog": { - "description": "The new blog URL of the user.", - "type": "string" + "type": "string", + "description": "The new blog URL of the user." }, "company": { - "description": "The new company of the user.", - "type": "string" + "type": "string", + "description": "The new company of the user." }, "location": { - "description": "The new location of the user.", - "type": "string" + "type": "string", + "description": "The new location of the user." }, "hireable": { - "description": "The new hiring availability of the user.", - "type": "boolean" + "type": "boolean", + "description": "The new hiring availability of the user." }, "bio": { - "description": "The new short biography of the user.", - "type": "string" + "type": "string", + "description": "The new short biography of the user." } } } diff --git a/openapi/ghe-2.17/operations/activity/check-starring-repo.json b/openapi/ghe-2.17/operations/activity/check-starring-repo.json index 2f46d9e094..bdc013f29e 100644 --- a/openapi/ghe-2.17/operations/activity/check-starring-repo.json +++ b/openapi/ghe-2.17/operations/activity/check-starring-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/check-watching-repo-legacy.json b/openapi/ghe-2.17/operations/activity/check-watching-repo-legacy.json index 9f89bda8ac..971d9a92bb 100644 --- a/openapi/ghe-2.17/operations/activity/check-watching-repo-legacy.json +++ b/openapi/ghe-2.17/operations/activity/check-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/delete-repo-subscription.json b/openapi/ghe-2.17/operations/activity/delete-repo-subscription.json index 8d93934cd3..e2473bbc77 100644 --- a/openapi/ghe-2.17/operations/activity/delete-repo-subscription.json +++ b/openapi/ghe-2.17/operations/activity/delete-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/delete-thread-subscription.json b/openapi/ghe-2.17/operations/activity/delete-thread-subscription.json index 8cd11c24fd..91822c0f5b 100644 --- a/openapi/ghe-2.17/operations/activity/delete-thread-subscription.json +++ b/openapi/ghe-2.17/operations/activity/delete-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/get-repo-subscription.json b/openapi/ghe-2.17/operations/activity/get-repo-subscription.json index 3c57289bdb..4f46fad688 100644 --- a/openapi/ghe-2.17/operations/activity/get-repo-subscription.json +++ b/openapi/ghe-2.17/operations/activity/get-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/get-thread-subscription.json b/openapi/ghe-2.17/operations/activity/get-thread-subscription.json index 7176f24460..0aa10942ec 100644 --- a/openapi/ghe-2.17/operations/activity/get-thread-subscription.json +++ b/openapi/ghe-2.17/operations/activity/get-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/get-thread.json b/openapi/ghe-2.17/operations/activity/get-thread.json index 58af8125c6..7fbaa702e5 100644 --- a/openapi/ghe-2.17/operations/activity/get-thread.json +++ b/openapi/ghe-2.17/operations/activity/get-thread.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-events-for-org.json b/openapi/ghe-2.17/operations/activity/list-events-for-org.json index b871cd4ab3..7597c567aa 100644 --- a/openapi/ghe-2.17/operations/activity/list-events-for-org.json +++ b/openapi/ghe-2.17/operations/activity/list-events-for-org.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-events-for-user.json b/openapi/ghe-2.17/operations/activity/list-events-for-user.json index 2cdda1856d..bc9bd12a13 100644 --- a/openapi/ghe-2.17/operations/activity/list-events-for-user.json +++ b/openapi/ghe-2.17/operations/activity/list-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-notifications-for-repo.json b/openapi/ghe-2.17/operations/activity/list-notifications-for-repo.json index 0a58764454..4c95b2266b 100644 --- a/openapi/ghe-2.17/operations/activity/list-notifications-for-repo.json +++ b/openapi/ghe-2.17/operations/activity/list-notifications-for-repo.json @@ -21,79 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-notifications.json b/openapi/ghe-2.17/operations/activity/list-notifications.json index 68de020df1..bf42b6b349 100644 --- a/openapi/ghe-2.17/operations/activity/list-notifications.json +++ b/openapi/ghe-2.17/operations/activity/list-notifications.json @@ -21,61 +21,59 @@ }, { "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, show notifications marked as read." + } }, { "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "query", + "required": false, "schema": { "type": "boolean", "default": false - }, - "required": false, - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + } }, { "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-public-events-for-org.json b/openapi/ghe-2.17/operations/activity/list-public-events-for-org.json index 88ad7248c1..3c866cd2d9 100644 --- a/openapi/ghe-2.17/operations/activity/list-public-events-for-org.json +++ b/openapi/ghe-2.17/operations/activity/list-public-events-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-public-events-for-repo-network.json b/openapi/ghe-2.17/operations/activity/list-public-events-for-repo-network.json index 63dfbd66c4..60a31142c8 100644 --- a/openapi/ghe-2.17/operations/activity/list-public-events-for-repo-network.json +++ b/openapi/ghe-2.17/operations/activity/list-public-events-for-repo-network.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-public-events-for-user.json b/openapi/ghe-2.17/operations/activity/list-public-events-for-user.json index 19195b0059..ccb25ee67f 100644 --- a/openapi/ghe-2.17/operations/activity/list-public-events-for-user.json +++ b/openapi/ghe-2.17/operations/activity/list-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-public-events.json b/openapi/ghe-2.17/operations/activity/list-public-events.json index fb9fc853ee..e52d350462 100644 --- a/openapi/ghe-2.17/operations/activity/list-public-events.json +++ b/openapi/ghe-2.17/operations/activity/list-public-events.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-received-events-for-user.json b/openapi/ghe-2.17/operations/activity/list-received-events-for-user.json index 7f78b1a1a8..3da3bafa69 100644 --- a/openapi/ghe-2.17/operations/activity/list-received-events-for-user.json +++ b/openapi/ghe-2.17/operations/activity/list-received-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-received-public-events-for-user.json b/openapi/ghe-2.17/operations/activity/list-received-public-events-for-user.json index a1fadec23a..6106618a39 100644 --- a/openapi/ghe-2.17/operations/activity/list-received-public-events-for-user.json +++ b/openapi/ghe-2.17/operations/activity/list-received-public-events-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-repo-events.json b/openapi/ghe-2.17/operations/activity/list-repo-events.json index 8dfa5999d3..966c18f0a7 100644 --- a/openapi/ghe-2.17/operations/activity/list-repo-events.json +++ b/openapi/ghe-2.17/operations/activity/list-repo-events.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-repos-starred-by-authenticated-user.json b/openapi/ghe-2.17/operations/activity/list-repos-starred-by-authenticated-user.json index 7498c8de5b..a94c24cb59 100644 --- a/openapi/ghe-2.17/operations/activity/list-repos-starred-by-authenticated-user.json +++ b/openapi/ghe-2.17/operations/activity/list-repos-starred-by-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -29,13 +31,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -43,29 +45,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-repos-starred-by-user.json b/openapi/ghe-2.17/operations/activity/list-repos-starred-by-user.json index 027a7ce0d6..6646540a35 100644 --- a/openapi/ghe-2.17/operations/activity/list-repos-starred-by-user.json +++ b/openapi/ghe-2.17/operations/activity/list-repos-starred-by-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + } }, { "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "One of `asc` (ascending) or `desc` (descending)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-repos-watched-by-user.json b/openapi/ghe-2.17/operations/activity/list-repos-watched-by-user.json index 69161f007f..4912e00eed 100644 --- a/openapi/ghe-2.17/operations/activity/list-repos-watched-by-user.json +++ b/openapi/ghe-2.17/operations/activity/list-repos-watched-by-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-stargazers-for-repo.json b/openapi/ghe-2.17/operations/activity/list-stargazers-for-repo.json index 3a8952ae17..4b6faf2edc 100644 --- a/openapi/ghe-2.17/operations/activity/list-stargazers-for-repo.json +++ b/openapi/ghe-2.17/operations/activity/list-stargazers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-watched-repos-for-authenticated-user.json b/openapi/ghe-2.17/operations/activity/list-watched-repos-for-authenticated-user.json index 0fe1301d46..f58eb972bc 100644 --- a/openapi/ghe-2.17/operations/activity/list-watched-repos-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/activity/list-watched-repos-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/list-watchers-for-repo.json b/openapi/ghe-2.17/operations/activity/list-watchers-for-repo.json index a8e5e5c6f7..cde28ad492 100644 --- a/openapi/ghe-2.17/operations/activity/list-watchers-for-repo.json +++ b/openapi/ghe-2.17/operations/activity/list-watchers-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/mark-as-read.json b/openapi/ghe-2.17/operations/activity/mark-as-read.json index fb8ae917f7..bea9303d84 100644 --- a/openapi/ghe-2.17/operations/activity/mark-as-read.json +++ b/openapi/ghe-2.17/operations/activity/mark-as-read.json @@ -48,8 +48,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/ghe-2.17/operations/activity/mark-notifications-as-read-for-repo.json b/openapi/ghe-2.17/operations/activity/mark-notifications-as-read-for-repo.json index a9567abe81..05a8bfe910 100644 --- a/openapi/ghe-2.17/operations/activity/mark-notifications-as-read-for-repo.json +++ b/openapi/ghe-2.17/operations/activity/mark-notifications-as-read-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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" + "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: current date/time" } } } diff --git a/openapi/ghe-2.17/operations/activity/mark-thread-as-read.json b/openapi/ghe-2.17/operations/activity/mark-thread-as-read.json index ba4aa6ccee..2cac6e8c19 100644 --- a/openapi/ghe-2.17/operations/activity/mark-thread-as-read.json +++ b/openapi/ghe-2.17/operations/activity/mark-thread-as-read.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/set-repo-subscription.json b/openapi/ghe-2.17/operations/activity/set-repo-subscription.json index f666d26e0e..966f815f1d 100644 --- a/openapi/ghe-2.17/operations/activity/set-repo-subscription.json +++ b/openapi/ghe-2.17/operations/activity/set-repo-subscription.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -93,12 +93,12 @@ "type": "object", "properties": { "subscribed": { - "description": "Determines if notifications should be received from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if notifications should be received from this repository." }, "ignored": { - "description": "Determines if all notifications should be blocked from this repository.", - "type": "boolean" + "type": "boolean", + "description": "Determines if all notifications should be blocked from this repository." } } } diff --git a/openapi/ghe-2.17/operations/activity/set-thread-subscription.json b/openapi/ghe-2.17/operations/activity/set-thread-subscription.json index 833792ce22..105d4320ac 100644 --- a/openapi/ghe-2.17/operations/activity/set-thread-subscription.json +++ b/openapi/ghe-2.17/operations/activity/set-thread-subscription.json @@ -21,12 +21,12 @@ }, { "name": "thread_id", + "description": "thread_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "thread_id parameter" + } } ], "responses": { @@ -84,8 +84,8 @@ "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", + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", "default": false } } diff --git a/openapi/ghe-2.17/operations/activity/star-repo.json b/openapi/ghe-2.17/operations/activity/star-repo.json index e98acf8330..58346b7e38 100644 --- a/openapi/ghe-2.17/operations/activity/star-repo.json +++ b/openapi/ghe-2.17/operations/activity/star-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/stop-watching-repo-legacy.json b/openapi/ghe-2.17/operations/activity/stop-watching-repo-legacy.json index e153cdb112..ed49f52779 100644 --- a/openapi/ghe-2.17/operations/activity/stop-watching-repo-legacy.json +++ b/openapi/ghe-2.17/operations/activity/stop-watching-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/unstar-repo.json b/openapi/ghe-2.17/operations/activity/unstar-repo.json index 346adf28e9..2d6af60487 100644 --- a/openapi/ghe-2.17/operations/activity/unstar-repo.json +++ b/openapi/ghe-2.17/operations/activity/unstar-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/activity/watch-repo-legacy.json b/openapi/ghe-2.17/operations/activity/watch-repo-legacy.json index 7c8384a8da..f24f424813 100644 --- a/openapi/ghe-2.17/operations/activity/watch-repo-legacy.json +++ b/openapi/ghe-2.17/operations/activity/watch-repo-legacy.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/add-repo-to-installation.json b/openapi/ghe-2.17/operations/apps/add-repo-to-installation.json index adb264d7af..9dffc0b894 100644 --- a/openapi/ghe-2.17/operations/apps/add-repo-to-installation.json +++ b/openapi/ghe-2.17/operations/apps/add-repo-to-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/create-content-attachment.json b/openapi/ghe-2.17/operations/apps/create-content-attachment.json index d756cda793..821b12236a 100644 --- a/openapi/ghe-2.17/operations/apps/create-content-attachment.json +++ b/openapi/ghe-2.17/operations/apps/create-content-attachment.json @@ -22,12 +22,12 @@ }, { "name": "content_reference_id", + "description": "content_reference_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "content_reference_id parameter" + } } ], "responses": { @@ -76,12 +76,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", - "type": "string" + "type": "string", + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request." }, "body": { - "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", - "type": "string" + "type": "string", + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/apps/create-from-manifest.json b/openapi/ghe-2.17/operations/apps/create-from-manifest.json index 206b71c70d..d4d708011f 100644 --- a/openapi/ghe-2.17/operations/apps/create-from-manifest.json +++ b/openapi/ghe-2.17/operations/apps/create-from-manifest.json @@ -22,12 +22,12 @@ }, { "name": "code", + "description": "code parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "code parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/create-installation-token.json b/openapi/ghe-2.17/operations/apps/create-installation-token.json index c1b9e91c1d..2f6ae84655 100644 --- a/openapi/ghe-2.17/operations/apps/create-installation-token.json +++ b/openapi/ghe-2.17/operations/apps/create-installation-token.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { @@ -382,15 +382,15 @@ "type": "object", "properties": { "repository_ids": { - "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/enterprise/2.17/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", "type": "array", + "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/enterprise/2.17/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.", "items": { "type": "integer" } }, "permissions": { - "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/enterprise/2.17/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", "type": "object", + "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/enterprise/2.17/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"", "properties": {} } } diff --git a/openapi/ghe-2.17/operations/apps/delete-installation.json b/openapi/ghe-2.17/operations/apps/delete-installation.json index 283fd9dad3..c312f124e8 100644 --- a/openapi/ghe-2.17/operations/apps/delete-installation.json +++ b/openapi/ghe-2.17/operations/apps/delete-installation.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/get-by-slug.json b/openapi/ghe-2.17/operations/apps/get-by-slug.json index f8246a7933..32591994ff 100644 --- a/openapi/ghe-2.17/operations/apps/get-by-slug.json +++ b/openapi/ghe-2.17/operations/apps/get-by-slug.json @@ -22,12 +22,12 @@ }, { "name": "app_slug", + "description": "app_slug parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "app_slug parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/get-installation.json b/openapi/ghe-2.17/operations/apps/get-installation.json index c7aa38483b..37d742ffff 100644 --- a/openapi/ghe-2.17/operations/apps/get-installation.json +++ b/openapi/ghe-2.17/operations/apps/get-installation.json @@ -22,12 +22,12 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/get-org-installation.json b/openapi/ghe-2.17/operations/apps/get-org-installation.json index 169ccfd618..5902a501c2 100644 --- a/openapi/ghe-2.17/operations/apps/get-org-installation.json +++ b/openapi/ghe-2.17/operations/apps/get-org-installation.json @@ -22,12 +22,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/get-repo-installation.json b/openapi/ghe-2.17/operations/apps/get-repo-installation.json index 6ed5994004..b6ab46e67a 100644 --- a/openapi/ghe-2.17/operations/apps/get-repo-installation.json +++ b/openapi/ghe-2.17/operations/apps/get-repo-installation.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/get-user-installation.json b/openapi/ghe-2.17/operations/apps/get-user-installation.json index 28eb792ae9..e49604ef9b 100644 --- a/openapi/ghe-2.17/operations/apps/get-user-installation.json +++ b/openapi/ghe-2.17/operations/apps/get-user-installation.json @@ -22,12 +22,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/list-installation-repos-for-authenticated-user.json b/openapi/ghe-2.17/operations/apps/list-installation-repos-for-authenticated-user.json index b1f710b4d4..579378e0b2 100644 --- a/openapi/ghe-2.17/operations/apps/list-installation-repos-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/apps/list-installation-repos-for-authenticated-user.json @@ -22,32 +22,30 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/list-installations-for-authenticated-user.json b/openapi/ghe-2.17/operations/apps/list-installations-for-authenticated-user.json index 295c5fe257..40f5a017bc 100644 --- a/openapi/ghe-2.17/operations/apps/list-installations-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/apps/list-installations-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/list-installations.json b/openapi/ghe-2.17/operations/apps/list-installations.json index a9547c52bc..b0014515ff 100644 --- a/openapi/ghe-2.17/operations/apps/list-installations.json +++ b/openapi/ghe-2.17/operations/apps/list-installations.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/list-repos.json b/openapi/ghe-2.17/operations/apps/list-repos.json index 00b24910b7..1f04305b9d 100644 --- a/openapi/ghe-2.17/operations/apps/list-repos.json +++ b/openapi/ghe-2.17/operations/apps/list-repos.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/apps/remove-repo-from-installation.json b/openapi/ghe-2.17/operations/apps/remove-repo-from-installation.json index 82978221d9..d6f5d760a0 100644 --- a/openapi/ghe-2.17/operations/apps/remove-repo-from-installation.json +++ b/openapi/ghe-2.17/operations/apps/remove-repo-from-installation.json @@ -22,21 +22,21 @@ }, { "name": "installation_id", + "description": "installation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "installation_id parameter" + } }, { "name": "repository_id", + "description": "repository_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "repository_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/create-suite.json b/openapi/ghe-2.17/operations/checks/create-suite.json index c6b7397970..3e616e5959 100644 --- a/openapi/ghe-2.17/operations/checks/create-suite.json +++ b/openapi/ghe-2.17/operations/checks/create-suite.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -483,8 +483,8 @@ "type": "object", "properties": { "head_sha": { - "description": "The sha of the head commit.", - "type": "string" + "type": "string", + "description": "The sha of the head commit." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/checks/create.json b/openapi/ghe-2.17/operations/checks/create.json index 4c513fbb06..3e31873a05 100644 --- a/openapi/ghe-2.17/operations/checks/create.json +++ b/openapi/ghe-2.17/operations/checks/create.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -271,24 +271,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "head_sha": { - "description": "The SHA of the commit.", - "type": "string" + "type": "string", + "description": "The SHA of the commit." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -297,12 +297,12 @@ "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" + "type": "string", + "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`." }, "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", + "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`.", "enum": [ "success", "failure", @@ -313,54 +313,54 @@ ] }, "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" + "type": "string", + "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`." }, "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.17/v3/checks/runs/#output-object) description.", "type": "object", + "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.17/v3/checks/runs/#output-object) description.", "properties": { "title": { - "description": "The title of the check run.", - "type": "string" + "type": "string", + "description": "The title of the check run." }, "summary": { - "description": "The summary of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The summary of the check run. This parameter supports Markdown." }, "text": { - "description": "The details of the check run. This parameter supports Markdown.", - "type": "string" + "type": "string", + "description": "The details of the check run. This parameter supports Markdown." }, "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.17/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.17/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "type": "array", + "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.17/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.17/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -368,16 +368,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -390,22 +390,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#images-object) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#images-object) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -421,22 +421,22 @@ ] }, "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.17/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.17/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "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.17/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.17/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/checks/get-suite.json b/openapi/ghe-2.17/operations/checks/get-suite.json index c3ef88f106..3e2d45d573 100644 --- a/openapi/ghe-2.17/operations/checks/get-suite.json +++ b/openapi/ghe-2.17/operations/checks/get-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/get.json b/openapi/ghe-2.17/operations/checks/get.json index d9a6f3c60c..d9385aba00 100644 --- a/openapi/ghe-2.17/operations/checks/get.json +++ b/openapi/ghe-2.17/operations/checks/get.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/list-annotations.json b/openapi/ghe-2.17/operations/checks/list-annotations.json index 85037c5d60..6fc8c4da98 100644 --- a/openapi/ghe-2.17/operations/checks/list-annotations.json +++ b/openapi/ghe-2.17/operations/checks/list-annotations.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/list-for-ref.json b/openapi/ghe-2.17/operations/checks/list-for-ref.json index 1f5ebd99d8..5785b0e22b 100644 --- a/openapi/ghe-2.17/operations/checks/list-for-ref.json +++ b/openapi/ghe-2.17/operations/checks/list-for-ref.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/list-for-suite.json b/openapi/ghe-2.17/operations/checks/list-for-suite.json index b43382c730..2c1a4367a9 100644 --- a/openapi/ghe-2.17/operations/checks/list-for-suite.json +++ b/openapi/ghe-2.17/operations/checks/list-for-suite.json @@ -22,43 +22,45 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } }, { "name": "check_name", + "description": "Returns check runs with the specified `name`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Returns check runs with the specified `name`." + } }, { "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -66,13 +68,13 @@ "in_progress", "completed" ] - }, - "required": false, - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + } }, { "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,29 +82,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/list-suites-for-ref.json b/openapi/ghe-2.17/operations/checks/list-suites-for-ref.json index 8bd644291a..b1f7b941c3 100644 --- a/openapi/ghe-2.17/operations/checks/list-suites-for-ref.json +++ b/openapi/ghe-2.17/operations/checks/list-suites-for-ref.json @@ -22,68 +22,66 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", "in": "query", + "required": false, "schema": { "type": "integer" - }, - "required": false, - "description": "Filters check suites by GitHub App `id`." + } }, { "name": "check_name", + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.17/v3/checks/runs/).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.17/v3/checks/runs/)." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/rerequest-suite.json b/openapi/ghe-2.17/operations/checks/rerequest-suite.json index d7e917cf8e..9825f6d8a5 100644 --- a/openapi/ghe-2.17/operations/checks/rerequest-suite.json +++ b/openapi/ghe-2.17/operations/checks/rerequest-suite.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_suite_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/checks/set-suites-preferences.json b/openapi/ghe-2.17/operations/checks/set-suites-preferences.json index 17a138bd84..abbd75353e 100644 --- a/openapi/ghe-2.17/operations/checks/set-suites-preferences.json +++ b/openapi/ghe-2.17/operations/checks/set-suites-preferences.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -405,18 +405,18 @@ "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.17/v3/checks/suites/#auto_trigger_checks-object) description for details.", "type": "array", + "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.17/v3/checks/suites/#auto_trigger_checks-object) description for details.", "items": { "type": "object", "properties": { "app_id": { - "description": "The `id` of the GitHub App.", - "type": "integer" + "type": "integer", + "description": "The `id` of the GitHub App." }, "setting": { - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "type": "boolean", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/checks/update.json b/openapi/ghe-2.17/operations/checks/update.json index b20b40bfb7..08322f6ef9 100644 --- a/openapi/ghe-2.17/operations/checks/update.json +++ b/openapi/ghe-2.17/operations/checks/update.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "check_run_id", + "description": "check_run_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "check_run_id parameter" + } } ], "responses": { @@ -286,24 +286,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the check. For example, \"code-coverage\".", - "type": "string" + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." }, "details_url": { - "description": "The URL of the integrator's site that has the full details of the check.", - "type": "string" + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." }, "external_id": { - "description": "A reference for the run on the integrator's system.", - "type": "string" + "type": "string", + "description": "A reference for the run on the integrator's system." }, "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" + "type": "string", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." }, "status": { - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "type": "string", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "enum": [ "queued", "in_progress", @@ -311,8 +311,8 @@ ] }, "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", + "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`.", "enum": [ "success", "failure", @@ -323,54 +323,54 @@ ] }, "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" + "type": "string", + "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`." }, "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.17/v3/checks/runs/#output-object-1) description.", "type": "object", + "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.17/v3/checks/runs/#output-object-1) description.", "properties": { "title": { - "description": "**Required**.", - "type": "string" + "type": "string", + "description": "**Required**." }, "summary": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "text": { - "description": "Can contain Markdown.", - "type": "string" + "type": "string", + "description": "Can contain Markdown." }, "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.17/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.17/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "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.17/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.17/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "path": { - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "type": "string" + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." }, "start_line": { - "description": "The start line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The start line of the annotation." }, "end_line": { - "description": "The end line of the annotation.", - "type": "integer" + "type": "integer", + "description": "The end line of the annotation." }, "start_column": { - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "end_column": { - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "type": "integer" + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." }, "annotation_level": { - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "type": "string", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "enum": [ "notice", "warning", @@ -378,16 +378,16 @@ ] }, "message": { - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." }, "title": { - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "type": "string" + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." }, "raw_details": { - "description": "Details about this annotation. The maximum size is 64 KB.", - "type": "string" + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." } }, "required": [ @@ -400,22 +400,22 @@ } }, "images": { - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#annotations-object-1) description for details.", "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#annotations-object-1) description for details.", "items": { "type": "object", "properties": { "alt": { - "description": "The alternative text for the image.", - "type": "string" + "type": "string", + "description": "The alternative text for the image." }, "image_url": { - "description": "The full URL of the image.", - "type": "string" + "type": "string", + "description": "The full URL of the image." }, "caption": { - "description": "A short image description.", - "type": "string" + "type": "string", + "description": "A short image description." } }, "required": [ @@ -430,22 +430,22 @@ ] }, "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.17/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\"", "type": "array", + "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.17/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\"", "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" + "type": "string", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." }, "description": { - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "type": "string" + "type": "string", + "description": "A short explanation of what this action would do. The maximum size is 40 characters." }, "identifier": { - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "type": "string" + "type": "string", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/codes-of-conduct/get-conduct-code.json b/openapi/ghe-2.17/operations/codes-of-conduct/get-conduct-code.json index 646f6e7dfd..23035cb85d 100644 --- a/openapi/ghe-2.17/operations/codes-of-conduct/get-conduct-code.json +++ b/openapi/ghe-2.17/operations/codes-of-conduct/get-conduct-code.json @@ -22,12 +22,12 @@ }, { "name": "key", + "description": "key parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/codes-of-conduct/get-for-repo.json b/openapi/ghe-2.17/operations/codes-of-conduct/get-for-repo.json index 1e5210efb1..7b2b282eee 100644 --- a/openapi/ghe-2.17/operations/codes-of-conduct/get-for-repo.json +++ b/openapi/ghe-2.17/operations/codes-of-conduct/get-for-repo.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/add-authorized-ssh-key.json b/openapi/ghe-2.17/operations/enterprise-admin/add-authorized-ssh-key.json index 56c5d42450..b2d108fc0c 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/add-authorized-ssh-key.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/add-authorized-ssh-key.json @@ -66,8 +66,8 @@ "type": "object", "properties": { "authorized_key": { - "description": "The path to the public SSH key.", - "type": "string" + "type": "string", + "description": "The path to the public SSH key." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/create-global-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/create-global-hook.json index a58a8b0398..19b033513a 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/create-global-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/create-global-hook.json @@ -105,28 +105,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.17/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.17/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -134,15 +134,15 @@ ] }, "events": { - "description": "The [events](https://developer.github.com/enterprise/2.17/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", + "description": "The [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/enterprise-admin/create-impersonation-o-auth-token.json b/openapi/ghe-2.17/operations/enterprise-admin/create-impersonation-o-auth-token.json index c5ece34740..8e280698fd 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/create-impersonation-o-auth-token.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/create-impersonation-o-auth-token.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -116,8 +116,8 @@ "type": "object", "properties": { "scopes": { - "description": "A list of [scopes](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "type": "array", + "description": "A list of [scopes](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/create-org.json b/openapi/ghe-2.17/operations/enterprise-admin/create-org.json index a2457dbdaf..2f78d2a30a 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/create-org.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/create-org.json @@ -93,16 +93,16 @@ "type": "object", "properties": { "login": { - "description": "The organization's username.", - "type": "string" + "type": "string", + "description": "The organization's username." }, "admin": { - "description": "The login of the user who will manage this organization.", - "type": "string" + "type": "string", + "description": "The login of the user who will manage this organization." }, "profile_name": { - "description": "The organization's display name.", - "type": "string" + "type": "string", + "description": "The organization's display name." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-environment.json b/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-environment.json index dc047eee68..31e2bd2df4 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-environment.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-environment.json @@ -98,12 +98,12 @@ "type": "object", "properties": { "name": { - "description": "The new pre-receive environment's name.", - "type": "string" + "type": "string", + "description": "The new pre-receive environment's name." }, "image_url": { - "description": "URL from which to download a tarball of this environment.", - "type": "string" + "type": "string", + "description": "URL from which to download a tarball of this environment." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-hook.json index c69b721f53..37f22305f0 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/create-pre-receive-hook.json @@ -135,30 +135,30 @@ "type": "object", "properties": { "name": { - "description": "The name of the hook.", - "type": "string" + "type": "string", + "description": "The name of the hook." }, "script": { - "description": "The script that the hook runs.", - "type": "string" + "type": "string", + "description": "The script that the hook runs." }, "script_repository": { - "description": "The GitHub repository where the script is kept.", "type": "object", + "description": "The GitHub repository where the script is kept.", "properties": {} }, "environment": { - "description": "The pre-receive environment where the script is executed.", "type": "object", + "description": "The pre-receive environment where the script is executed.", "properties": {} }, "enforcement": { - "description": "The state of enforcement for this hook. default: `disabled`", - "type": "string" + "type": "string", + "description": "The state of enforcement for this hook. default: `disabled`" }, "allow_downstream_configuration": { - "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "type": "boolean" + "type": "boolean", + "description": "Whether enforcement can be overridden at the org or repo level. default: `false`" } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/create-user.json b/openapi/ghe-2.17/operations/enterprise-admin/create-user.json index fcdb455644..b71ee35ac6 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/create-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/create-user.json @@ -111,12 +111,12 @@ "type": "object", "properties": { "login": { - "description": "The user's username.", - "type": "string" + "type": "string", + "description": "The user's username." }, "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 Server authentication guide](https://help.github.com/enterprise/2.17/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", - "type": "string" + "type": "string", + "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 Server authentication guide](https://help.github.com/enterprise/2.17/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/)." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-global-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-global-hook.json index f1efd9cf6d..66a3710271 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-global-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-impersonation-o-auth-token.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-impersonation-o-auth-token.json index 87e8568055..bd33f33fd2 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-impersonation-o-auth-token.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-impersonation-o-auth-token.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-personal-access-token.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-personal-access-token.json index d84c85ab6f..08170f5319 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-personal-access-token.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-personal-access-token.json @@ -21,12 +21,12 @@ }, { "name": "token_id", + "description": "token_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "token_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-environment.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-environment.json index e2762db66d..c559bc508a 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-environment.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-hook.json index 4517669b90..02aaa9de76 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-public-key.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-public-key.json index 2fd8641648..973755812f 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-public-key.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_ids", + "description": "key_ids parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "key_ids parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/delete-user.json b/openapi/ghe-2.17/operations/enterprise-admin/delete-user.json index 861c6136b9..9cd8621c6d 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/delete-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/delete-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json b/openapi/ghe-2.17/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json index fce53cbf7e..9090b26169 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/enable-or-disable-maintenance-mode.json b/openapi/ghe-2.17/operations/enterprise-admin/enable-or-disable-maintenance-mode.json index 54d52b6ae5..1d55217a24 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/enable-or-disable-maintenance-mode.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/enable-or-disable-maintenance-mode.json @@ -81,8 +81,8 @@ "type": "object", "properties": { "maintenance": { - "description": "A JSON string with the attributes `enabled` and `when`.", - "type": "string" + "type": "string", + "description": "A JSON string with the attributes `enabled` and `when`." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-global-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/get-global-hook.json index bcb2396efa..942c16927b 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-global-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment-download-status.json b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment-download-status.json index d2c3579fbe..90872b3f23 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment-download-status.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment-download-status.json @@ -21,39 +21,39 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } }, { "name": "state", + "description": "The state of the most recent download.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The state of the most recent download." + } }, { "name": "downloaded_at", + "description": "The time when the most recent download started.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The time when the most recent download started." + } }, { "name": "message", + "description": "On failure, this will have any error messages produced.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "On failure, this will have any error messages produced." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment.json b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment.json index 662d8c2632..14c53d08bf 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-org.json b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-org.json index 51d8120900..81dce08d09 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-org.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-repo.json b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-repo.json index a6b043b6ea..d756f523dd 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-repo.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook.json index f393248458..2dbdb75e4b 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/get-type-stats.json b/openapi/ghe-2.17/operations/enterprise-admin/get-type-stats.json index c93a613cf4..257a08f2c3 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/get-type-stats.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/get-type-stats.json @@ -21,12 +21,12 @@ }, { "name": "type", + "description": "type parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "type parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/list-global-hooks.json b/openapi/ghe-2.17/operations/enterprise-admin/list-global-hooks.json index d87c3cb4ca..820960fba4 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/list-global-hooks.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/list-global-hooks.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/list-personal-access-tokens.json b/openapi/ghe-2.17/operations/enterprise-admin/list-personal-access-tokens.json index 041a1f8d72..289dbf0c6b 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/list-personal-access-tokens.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/list-personal-access-tokens.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-environments.json b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-environments.json index 57d3279a44..f48f4ae49c 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-environments.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-environments.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-org.json b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-org.json index a0e02b6864..40e727a678 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-org.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-org.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json index e3c9c690da..de618dfb94 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks.json b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks.json index 53d682d487..9839df5f6e 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/list-pre-receive-hooks.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/modify-settings.json b/openapi/ghe-2.17/operations/enterprise-admin/modify-settings.json index b33b483580..73e129a103 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/modify-settings.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/modify-settings.json @@ -48,8 +48,8 @@ "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" + "type": "string", + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/ping-global-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/ping-global-hook.json index f287fed90d..9f43e36beb 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/ping-global-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/ping-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json b/openapi/ghe-2.17/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json index 2ef0e43f37..c18ce35ff2 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/queue-indexing-job.json b/openapi/ghe-2.17/operations/enterprise-admin/queue-indexing-job.json index d49331a409..b4ceb70117 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/queue-indexing-job.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/queue-indexing-job.json @@ -60,8 +60,8 @@ "type": "object", "properties": { "target": { - "description": "A string representing the item to index.", - "type": "string" + "type": "string", + "description": "A string representing the item to index." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/remove-authorized-ssh-key.json b/openapi/ghe-2.17/operations/enterprise-admin/remove-authorized-ssh-key.json index 74040c58ed..37017620a1 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/remove-authorized-ssh-key.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/remove-authorized-ssh-key.json @@ -66,8 +66,8 @@ "type": "object", "properties": { "authorized_key": { - "description": "The path to the public SSH key.", - "type": "string" + "type": "string", + "description": "The path to the public SSH key." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json b/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json index db2d4b2696..7e8590e397 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json b/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json index 6a5090d19e..6a07788bac 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/rename-org.json b/openapi/ghe-2.17/operations/enterprise-admin/rename-org.json index b7f105668a..2e61a98cb0 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/rename-org.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/rename-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -72,8 +72,8 @@ "type": "object", "properties": { "login": { - "description": "The organization's new name.", - "type": "string" + "type": "string", + "description": "The organization's new name." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/rename-user.json b/openapi/ghe-2.17/operations/enterprise-admin/rename-user.json index a1d18a2d52..f725778d1e 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/rename-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/rename-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -72,8 +72,8 @@ "type": "object", "properties": { "login": { - "description": "The user's new username.", - "type": "string" + "type": "string", + "description": "The user's new username." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/enterprise-admin/suspend-user.json b/openapi/ghe-2.17/operations/enterprise-admin/suspend-user.json index 0f82f5cd3b..ceb9cda0c0 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/suspend-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/suspend-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -57,8 +57,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-team.json b/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-team.json index e95328d40d..85826aebb2 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-team.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-team.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-user.json b/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-user.json index c2b2fe0056..ec958d3abe 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/sync-ldap-mapping-for-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/trigger-pre-receive-environment-download.json b/openapi/ghe-2.17/operations/enterprise-admin/trigger-pre-receive-environment-download.json index fd7b4c88c4..a17981aebc 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/trigger-pre-receive-environment-download.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/trigger-pre-receive-environment-download.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/unsuspend-user.json b/openapi/ghe-2.17/operations/enterprise-admin/unsuspend-user.json index 17cc18c871..53efcaaa44 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/unsuspend-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/unsuspend-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -57,8 +57,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-global-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/update-global-hook.json index 19bbba050e..1324fef46c 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-global-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-global-hook.json @@ -22,12 +22,12 @@ }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -111,24 +111,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.17/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.17/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -136,15 +136,15 @@ ] }, "events": { - "description": "The [events](https://developer.github.com/enterprise/2.17/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", + "description": "The [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-team.json b/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-team.json index 619f63516a..bf91a2e8dc 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-team.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-team.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -102,8 +102,8 @@ "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" + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." } } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-user.json b/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-user.json index 6af862f551..fff38bd6eb 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-user.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-ldap-mapping-for-user.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -123,8 +123,8 @@ "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" + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team." } } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-environment.json b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-environment.json index 56374af7e3..dfdeb20105 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-environment.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-environment.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_environment_id", + "description": "pre_receive_environment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_environment_id parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "name": { - "description": "This pre-receive environment's new name.", - "type": "string" + "type": "string", + "description": "This pre-receive environment's new name." }, "image_url": { - "description": "URL from which to download a tarball of this environment.", - "type": "string" + "type": "string", + "description": "URL from which to download a tarball of this environment." } } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json index d67d262b9b..b4fbab9dc2 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json index f4a175672b..806c12fae5 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook.json b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook.json index 572637fc82..e0926a0b77 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/update-pre-receive-hook.json @@ -21,12 +21,12 @@ }, { "name": "pre_receive_hook_id", + "description": "pre_receive_hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pre_receive_hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/enterprise-admin/upgrade-license.json b/openapi/ghe-2.17/operations/enterprise-admin/upgrade-license.json index 48a1cd0601..8a7a70962f 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/upgrade-license.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/upgrade-license.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "license": { - "description": "The content of your new _.ghl_ license file.", - "type": "string" + "type": "string", + "description": "The content of your new _.ghl_ license file." } } } diff --git a/openapi/ghe-2.17/operations/enterprise-admin/upload-license-for-first-time.json b/openapi/ghe-2.17/operations/enterprise-admin/upload-license-for-first-time.json index 0b007c0612..baa1e1d5ef 100644 --- a/openapi/ghe-2.17/operations/enterprise-admin/upload-license-for-first-time.json +++ b/openapi/ghe-2.17/operations/enterprise-admin/upload-license-for-first-time.json @@ -48,16 +48,16 @@ "type": "object", "properties": { "license": { - "description": "The content of your _.ghl_ license file.", - "type": "string" + "type": "string", + "description": "The content of your _.ghl_ license file." }, "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" + "type": "string", + "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." }, "settings": { - "description": "An optional JSON string containing the installation settings.", - "type": "string" + "type": "string", + "description": "An optional JSON string containing the installation settings." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/gists/check-is-starred.json b/openapi/ghe-2.17/operations/gists/check-is-starred.json index 88f9726dfc..389735ec3a 100644 --- a/openapi/ghe-2.17/operations/gists/check-is-starred.json +++ b/openapi/ghe-2.17/operations/gists/check-is-starred.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/create-comment.json b/openapi/ghe-2.17/operations/gists/create-comment.json index 96e713ba78..9bcc307273 100644 --- a/openapi/ghe-2.17/operations/gists/create-comment.json +++ b/openapi/ghe-2.17/operations/gists/create-comment.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -143,8 +143,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/gists/create.json b/openapi/ghe-2.17/operations/gists/create.json index a37dbcca2d..f6a211a2df 100644 --- a/openapi/ghe-2.17/operations/gists/create.json +++ b/openapi/ghe-2.17/operations/gists/create.json @@ -442,22 +442,22 @@ "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", + "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`.", "properties": { "content": { - "description": "The content of the file.", - "type": "string" + "type": "string", + "description": "The content of the file." } } }, "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "public": { - "description": "When `true`, the gist will be public and available for anyone to see.", "type": "boolean", + "description": "When `true`, the gist will be public and available for anyone to see.", "default": false } }, diff --git a/openapi/ghe-2.17/operations/gists/delete-comment.json b/openapi/ghe-2.17/operations/gists/delete-comment.json index 6818943032..ed418bc1cb 100644 --- a/openapi/ghe-2.17/operations/gists/delete-comment.json +++ b/openapi/ghe-2.17/operations/gists/delete-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/delete.json b/openapi/ghe-2.17/operations/gists/delete.json index a56059c63c..bf17ae2c38 100644 --- a/openapi/ghe-2.17/operations/gists/delete.json +++ b/openapi/ghe-2.17/operations/gists/delete.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/fork.json b/openapi/ghe-2.17/operations/gists/fork.json index a9ebfce527..7d73c55d87 100644 --- a/openapi/ghe-2.17/operations/gists/fork.json +++ b/openapi/ghe-2.17/operations/gists/fork.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/get-comment.json b/openapi/ghe-2.17/operations/gists/get-comment.json index 5ac2733377..5c4d9bcf07 100644 --- a/openapi/ghe-2.17/operations/gists/get-comment.json +++ b/openapi/ghe-2.17/operations/gists/get-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/get-revision.json b/openapi/ghe-2.17/operations/gists/get-revision.json index 5659708ad4..7b3442c25a 100644 --- a/openapi/ghe-2.17/operations/gists/get-revision.json +++ b/openapi/ghe-2.17/operations/gists/get-revision.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/get.json b/openapi/ghe-2.17/operations/gists/get.json index 73ac9a3abd..764dc769bd 100644 --- a/openapi/ghe-2.17/operations/gists/get.json +++ b/openapi/ghe-2.17/operations/gists/get.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list-comments.json b/openapi/ghe-2.17/operations/gists/list-comments.json index 403774975c..96327ead7e 100644 --- a/openapi/ghe-2.17/operations/gists/list-comments.json +++ b/openapi/ghe-2.17/operations/gists/list-comments.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list-commits.json b/openapi/ghe-2.17/operations/gists/list-commits.json index fef9d7f662..40d749fdc6 100644 --- a/openapi/ghe-2.17/operations/gists/list-commits.json +++ b/openapi/ghe-2.17/operations/gists/list-commits.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list-forks.json b/openapi/ghe-2.17/operations/gists/list-forks.json index 55a814724c..e5279047a2 100644 --- a/openapi/ghe-2.17/operations/gists/list-forks.json +++ b/openapi/ghe-2.17/operations/gists/list-forks.json @@ -21,32 +21,30 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list-public-for-user.json b/openapi/ghe-2.17/operations/gists/list-public-for-user.json index 8023076e43..99a1a4f2a0 100644 --- a/openapi/ghe-2.17/operations/gists/list-public-for-user.json +++ b/openapi/ghe-2.17/operations/gists/list-public-for-user.json @@ -21,41 +21,39 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list-public.json b/openapi/ghe-2.17/operations/gists/list-public.json index cdf9209b04..c275d21817 100644 --- a/openapi/ghe-2.17/operations/gists/list-public.json +++ b/openapi/ghe-2.17/operations/gists/list-public.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list-starred.json b/openapi/ghe-2.17/operations/gists/list-starred.json index 07518ef979..43d5615053 100644 --- a/openapi/ghe-2.17/operations/gists/list-starred.json +++ b/openapi/ghe-2.17/operations/gists/list-starred.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/list.json b/openapi/ghe-2.17/operations/gists/list.json index 3b36f969e1..0235e46ee3 100644 --- a/openapi/ghe-2.17/operations/gists/list.json +++ b/openapi/ghe-2.17/operations/gists/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/star.json b/openapi/ghe-2.17/operations/gists/star.json index fb2ddc40bd..5202e9f42e 100644 --- a/openapi/ghe-2.17/operations/gists/star.json +++ b/openapi/ghe-2.17/operations/gists/star.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/unstar.json b/openapi/ghe-2.17/operations/gists/unstar.json index faeb357743..4cd468fce2 100644 --- a/openapi/ghe-2.17/operations/gists/unstar.json +++ b/openapi/ghe-2.17/operations/gists/unstar.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/gists/update-comment.json b/openapi/ghe-2.17/operations/gists/update-comment.json index e4e1d509f8..e5805d237e 100644 --- a/openapi/ghe-2.17/operations/gists/update-comment.json +++ b/openapi/ghe-2.17/operations/gists/update-comment.json @@ -21,21 +21,21 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -152,8 +152,8 @@ "type": "object", "properties": { "body": { - "description": "The comment text.", - "type": "string" + "type": "string", + "description": "The comment text." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/gists/update.json b/openapi/ghe-2.17/operations/gists/update.json index 02ffb8f0ed..ef4e0fb107 100644 --- a/openapi/ghe-2.17/operations/gists/update.json +++ b/openapi/ghe-2.17/operations/gists/update.json @@ -21,12 +21,12 @@ }, { "name": "gist_id", + "description": "gist_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "gist_id parameter" + } } ], "responses": { @@ -451,20 +451,20 @@ "type": "object", "properties": { "description": { - "description": "A descriptive name for this gist.", - "type": "string" + "type": "string", + "description": "A descriptive name for this gist." }, "files": { - "description": "The filenames and content that make up this gist.", "type": "object", + "description": "The filenames and content that make up this gist.", "properties": { "content": { - "description": "The updated content of the file.", - "type": "string" + "type": "string", + "description": "The updated content of the file." }, "filename": { - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "type": "string" + "type": "string", + "description": "The new name for this file. To delete a file, set the value of the filename to `null`." } } } diff --git a/openapi/ghe-2.17/operations/git/create-blob.json b/openapi/ghe-2.17/operations/git/create-blob.json index f797580b36..35e97ef96c 100644 --- a/openapi/ghe-2.17/operations/git/create-blob.json +++ b/openapi/ghe-2.17/operations/git/create-blob.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,12 +81,12 @@ "type": "object", "properties": { "content": { - "description": "The new blob's content.", - "type": "string" + "type": "string", + "description": "The new blob's content." }, "encoding": { - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "default": "utf-8" } }, diff --git a/openapi/ghe-2.17/operations/git/create-commit.json b/openapi/ghe-2.17/operations/git/create-commit.json index 3df72ee109..928f066e6c 100644 --- a/openapi/ghe-2.17/operations/git/create-commit.json +++ b/openapi/ghe-2.17/operations/git/create-commit.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -157,59 +157,59 @@ "type": "object", "properties": { "message": { - "description": "The commit message", - "type": "string" + "type": "string", + "description": "The commit message" }, "tree": { - "description": "The SHA of the tree object this commit points to", - "type": "string" + "type": "string", + "description": "The SHA of the tree object this commit points to" }, "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", + "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.", "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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", + "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.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" }, "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" + "type": "string", + "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`." } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/git/create-ref.json b/openapi/ghe-2.17/operations/git/create-ref.json index ae83d14a51..386f73cfc7 100644 --- a/openapi/ghe-2.17/operations/git/create-ref.json +++ b/openapi/ghe-2.17/operations/git/create-ref.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -98,12 +98,12 @@ "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" + "type": "string", + "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." }, "sha": { - "description": "The SHA1 value for this reference.", - "type": "string" + "type": "string", + "description": "The SHA1 value for this reference." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/git/create-tag.json b/openapi/ghe-2.17/operations/git/create-tag.json index ae66a9db97..68f0ba187d 100644 --- a/openapi/ghe-2.17/operations/git/create-tag.json +++ b/openapi/ghe-2.17/operations/git/create-tag.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -135,20 +135,20 @@ "type": "object", "properties": { "tag": { - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "type": "string" + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." }, "message": { - "description": "The tag message.", - "type": "string" + "type": "string", + "description": "The tag message." }, "object": { - "description": "The SHA of the git object this is tagging.", - "type": "string" + "type": "string", + "description": "The SHA of the git object this is tagging." }, "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", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", "enum": [ "commit", "tree", @@ -156,20 +156,20 @@ ] }, "tagger": { - "description": "An object with information about the individual creating the tag.", "type": "object", + "description": "An object with information about the individual creating the tag.", "properties": { "name": { - "description": "The name of the author of the tag", - "type": "string" + "type": "string", + "description": "The name of the author of the tag" }, "email": { - "description": "The email of the author of the tag", - "type": "string" + "type": "string", + "description": "The email of the author of the tag" }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/ghe-2.17/operations/git/create-tree.json b/openapi/ghe-2.17/operations/git/create-tree.json index ff1a3e3945..b65e474d2e 100644 --- a/openapi/ghe-2.17/operations/git/create-tree.json +++ b/openapi/ghe-2.17/operations/git/create-tree.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -107,18 +107,18 @@ "type": "object", "properties": { "tree": { - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "items": { "type": "object", "properties": { "path": { - "description": "The file referenced in the tree.", - "type": "string" + "type": "string", + "description": "The file referenced in the tree." }, "mode": { - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", "type": "string", + "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.", "enum": [ "100644", "100755", @@ -128,8 +128,8 @@ ] }, "type": { - "description": "Either `blob`, `tree`, or `commit`.", "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", "enum": [ "blob", "tree", @@ -137,19 +137,19 @@ ] }, "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" + "type": "string", + "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." }, "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" + "type": "string", + "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." } } } }, "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" + "type": "string", + "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." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/git/delete-ref.json b/openapi/ghe-2.17/operations/git/delete-ref.json index 8ee0b2f214..d36b02dd3a 100644 --- a/openapi/ghe-2.17/operations/git/delete-ref.json +++ b/openapi/ghe-2.17/operations/git/delete-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/git/get-blob.json b/openapi/ghe-2.17/operations/git/get-blob.json index 637e7db4c1..717479f563 100644 --- a/openapi/ghe-2.17/operations/git/get-blob.json +++ b/openapi/ghe-2.17/operations/git/get-blob.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "file_sha", + "description": "file_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "file_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/git/get-commit.json b/openapi/ghe-2.17/operations/git/get-commit.json index ca8e5edd2a..de5f342075 100644 --- a/openapi/ghe-2.17/operations/git/get-commit.json +++ b/openapi/ghe-2.17/operations/git/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/git/get-tag.json b/openapi/ghe-2.17/operations/git/get-tag.json index bb7fb6735a..412fc6d235 100644 --- a/openapi/ghe-2.17/operations/git/get-tag.json +++ b/openapi/ghe-2.17/operations/git/get-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag_sha", + "description": "tag_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/git/get-tree.json b/openapi/ghe-2.17/operations/git/get-tree.json index fd4f777b80..2eb2387d03 100644 --- a/openapi/ghe-2.17/operations/git/get-tree.json +++ b/openapi/ghe-2.17/operations/git/get-tree.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-tree", "tags": [ "git" ], @@ -21,41 +21,41 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tree_sha", + "description": "tree_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tree_sha parameter" + } }, { "name": "recursive", + "description": "recursive parameter", "in": "query", "schema": { "type": "integer", "enum": [ 1 ] - }, - "description": "recursive parameter" + } } ], "responses": { @@ -70,7 +70,7 @@ }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" + "source": "octokit.git.getTree({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" } ], "x-github": { diff --git a/openapi/ghe-2.17/operations/git/update-ref.json b/openapi/ghe-2.17/operations/git/update-ref.json index 5eb159b5b3..aa9dc3e150 100644 --- a/openapi/ghe-2.17/operations/git/update-ref.json +++ b/openapi/ghe-2.17/operations/git/update-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { @@ -107,12 +107,12 @@ "type": "object", "properties": { "sha": { - "description": "The SHA1 value to set this reference to", - "type": "string" + "type": "string", + "description": "The SHA1 value to set this reference to" }, "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.17/operations/gitignore/get-template.json b/openapi/ghe-2.17/operations/gitignore/get-template.json index cfbdf850f5..dfb82601ee 100644 --- a/openapi/ghe-2.17/operations/gitignore/get-template.json +++ b/openapi/ghe-2.17/operations/gitignore/get-template.json @@ -21,12 +21,12 @@ }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/add-assignees.json b/openapi/ghe-2.17/operations/issues/add-assignees.json index cc73aff348..679b688871 100644 --- a/openapi/ghe-2.17/operations/issues/add-assignees.json +++ b/openapi/ghe-2.17/operations/issues/add-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -503,8 +503,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/issues/add-labels.json b/openapi/ghe-2.17/operations/issues/add-labels.json index 8472b51173..7d5d085de4 100644 --- a/openapi/ghe-2.17/operations/issues/add-labels.json +++ b/openapi/ghe-2.17/operations/issues/add-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -118,8 +118,8 @@ "type": "object", "properties": { "labels": { - "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "type": "array", + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/issues/check-assignee.json b/openapi/ghe-2.17/operations/issues/check-assignee.json index bcd5466d91..a27d6e49b4 100644 --- a/openapi/ghe-2.17/operations/issues/check-assignee.json +++ b/openapi/ghe-2.17/operations/issues/check-assignee.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "assignee", + "description": "assignee parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "assignee parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/create-comment.json b/openapi/ghe-2.17/operations/issues/create-comment.json index 8cd275f29c..c6eb3dd351 100644 --- a/openapi/ghe-2.17/operations/issues/create-comment.json +++ b/openapi/ghe-2.17/operations/issues/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -175,8 +175,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/issues/create-label.json b/openapi/ghe-2.17/operations/issues/create-label.json index f7cd4eb69a..c857b0059d 100644 --- a/openapi/ghe-2.17/operations/issues/create-label.json +++ b/openapi/ghe-2.17/operations/issues/create-label.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "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" + "type": "string", + "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/)." }, "color": { - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "type": "string" + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." }, "description": { - "description": "A short description of the label.", - "type": "string" + "type": "string", + "description": "A short description of the label." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/issues/create-milestone.json b/openapi/ghe-2.17/operations/issues/create-milestone.json index 9b50ee2046..12a728f4d0 100644 --- a/openapi/ghe-2.17/operations/issues/create-milestone.json +++ b/openapi/ghe-2.17/operations/issues/create-milestone.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -192,12 +192,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/issues/create.json b/openapi/ghe-2.17/operations/issues/create.json index b7f9a6f92f..7081f25b25 100644 --- a/openapi/ghe-2.17/operations/issues/create.json +++ b/openapi/ghe-2.17/operations/issues/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -524,31 +524,31 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "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" + "type": "string", + "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.**_" }, "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" + "type": "integer", + "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._" }, "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", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/issues/delete-comment.json b/openapi/ghe-2.17/operations/issues/delete-comment.json index 5faaabf14a..0b06b06764 100644 --- a/openapi/ghe-2.17/operations/issues/delete-comment.json +++ b/openapi/ghe-2.17/operations/issues/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/delete-label.json b/openapi/ghe-2.17/operations/issues/delete-label.json index 7167cbe25a..6c80261848 100644 --- a/openapi/ghe-2.17/operations/issues/delete-label.json +++ b/openapi/ghe-2.17/operations/issues/delete-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/delete-milestone.json b/openapi/ghe-2.17/operations/issues/delete-milestone.json index f9a6606fa4..75827ea198 100644 --- a/openapi/ghe-2.17/operations/issues/delete-milestone.json +++ b/openapi/ghe-2.17/operations/issues/delete-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/get-comment.json b/openapi/ghe-2.17/operations/issues/get-comment.json index 8e9fb55eb3..7b6ef7bfb8 100644 --- a/openapi/ghe-2.17/operations/issues/get-comment.json +++ b/openapi/ghe-2.17/operations/issues/get-comment.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/get-event.json b/openapi/ghe-2.17/operations/issues/get-event.json index a3e5857bb9..852901496d 100644 --- a/openapi/ghe-2.17/operations/issues/get-event.json +++ b/openapi/ghe-2.17/operations/issues/get-event.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "event_id", + "description": "event_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "event_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/get-label.json b/openapi/ghe-2.17/operations/issues/get-label.json index e31ea29d96..2a60ef1224 100644 --- a/openapi/ghe-2.17/operations/issues/get-label.json +++ b/openapi/ghe-2.17/operations/issues/get-label.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/get-milestone.json b/openapi/ghe-2.17/operations/issues/get-milestone.json index 06fb8bbea2..ff2cc8e28c 100644 --- a/openapi/ghe-2.17/operations/issues/get-milestone.json +++ b/openapi/ghe-2.17/operations/issues/get-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/get.json b/openapi/ghe-2.17/operations/issues/get.json index d9e23d95fb..5a6183336c 100644 --- a/openapi/ghe-2.17/operations/issues/get.json +++ b/openapi/ghe-2.17/operations/issues/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-assignees.json b/openapi/ghe-2.17/operations/issues/list-assignees.json index 2b3bab7574..c3a88c57e2 100644 --- a/openapi/ghe-2.17/operations/issues/list-assignees.json +++ b/openapi/ghe-2.17/operations/issues/list-assignees.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-comments-for-repo.json b/openapi/ghe-2.17/operations/issues/list-comments-for-repo.json index d7d94e17e5..bd955c790f 100644 --- a/openapi/ghe-2.17/operations/issues/list-comments-for-repo.json +++ b/openapi/ghe-2.17/operations/issues/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Either `created` or `updated`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,31 +49,29 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Either `created` or `updated`." + } }, { "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter." + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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": { diff --git a/openapi/ghe-2.17/operations/issues/list-comments.json b/openapi/ghe-2.17/operations/issues/list-comments.json index 7ed3065892..7d84319a3f 100644 --- a/openapi/ghe-2.17/operations/issues/list-comments.json +++ b/openapi/ghe-2.17/operations/issues/list-comments.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-events-for-repo.json b/openapi/ghe-2.17/operations/issues/list-events-for-repo.json index f9e27a3383..ffc8930280 100644 --- a/openapi/ghe-2.17/operations/issues/list-events-for-repo.json +++ b/openapi/ghe-2.17/operations/issues/list-events-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-events-for-timeline.json b/openapi/ghe-2.17/operations/issues/list-events-for-timeline.json index 8686f83269..c9bb7940c9 100644 --- a/openapi/ghe-2.17/operations/issues/list-events-for-timeline.json +++ b/openapi/ghe-2.17/operations/issues/list-events-for-timeline.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-events.json b/openapi/ghe-2.17/operations/issues/list-events.json index 7bff65cece..7e17ff627a 100644 --- a/openapi/ghe-2.17/operations/issues/list-events.json +++ b/openapi/ghe-2.17/operations/issues/list-events.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-for-authenticated-user.json b/openapi/ghe-2.17/operations/issues/list-for-authenticated-user.json index d2322b8625..f360704d35 100644 --- a/openapi/ghe-2.17/operations/issues/list-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/issues/list-for-authenticated-user.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-for-org.json b/openapi/ghe-2.17/operations/issues/list-for-org.json index 1acc8f16cd..5041336ad4 100644 --- a/openapi/ghe-2.17/operations/issues/list-for-org.json +++ b/openapi/ghe-2.17/operations/issues/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -41,13 +43,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -80,13 +82,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -94,38 +96,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-for-repo.json b/openapi/ghe-2.17/operations/issues/list-for-repo.json index dd90483458..88159b51ff 100644 --- a/openapi/ghe-2.17/operations/issues/list-for-repo.json +++ b/openapi/ghe-2.17/operations/issues/list-for-repo.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone", + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", "in": "query", + "required": false, "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,49 +59,49 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", "in": "query", + "required": false, "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", + "description": "The user that created the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The user that created the issue." + } }, { "name": "mentioned", + "description": "A user that's mentioned in the issue.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A user that's mentioned in the issue." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -108,13 +110,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -122,38 +124,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-labels-for-milestone.json b/openapi/ghe-2.17/operations/issues/list-labels-for-milestone.json index 19834c3622..4e8023d471 100644 --- a/openapi/ghe-2.17/operations/issues/list-labels-for-milestone.json +++ b/openapi/ghe-2.17/operations/issues/list-labels-for-milestone.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-labels-for-repo.json b/openapi/ghe-2.17/operations/issues/list-labels-for-repo.json index 59c8bf3436..e38fdc8e50 100644 --- a/openapi/ghe-2.17/operations/issues/list-labels-for-repo.json +++ b/openapi/ghe-2.17/operations/issues/list-labels-for-repo.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-labels-on-issue.json b/openapi/ghe-2.17/operations/issues/list-labels-on-issue.json index 01aa0399f1..543aa3b444 100644 --- a/openapi/ghe-2.17/operations/issues/list-labels-on-issue.json +++ b/openapi/ghe-2.17/operations/issues/list-labels-on-issue.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list-milestones-for-repo.json b/openapi/ghe-2.17/operations/issues/list-milestones-for-repo.json index 41f134a042..dc553d7c25 100644 --- a/openapi/ghe-2.17/operations/issues/list-milestones-for-repo.json +++ b/openapi/ghe-2.17/operations/issues/list-milestones-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,13 +50,13 @@ "all" ], "default": "open" - }, - "required": false, - "description": "The state of the milestone. Either `open`, `closed`, or `all`." + } }, { "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,13 +64,13 @@ "completeness" ], "default": "due_on" - }, - "required": false, - "description": "What to sort results by. Either `due_on` or `completeness`." + } }, { "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -76,29 +78,25 @@ "desc" ], "default": "asc" - }, - "required": false, - "description": "The direction of the sort. Either `asc` or `desc`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/list.json b/openapi/ghe-2.17/operations/issues/list.json index 042f1ff75b..d86177df3e 100644 --- a/openapi/ghe-2.17/operations/issues/list.json +++ b/openapi/ghe-2.17/operations/issues/list.json @@ -21,7 +21,9 @@ }, { "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -32,13 +34,13 @@ "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", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,22 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "A list of comma separated label names. Example: `bug,ui,@high`" + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -71,13 +73,13 @@ "comments" ], "default": "created" - }, - "required": false, - "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + } }, { "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -85,38 +87,34 @@ "desc" ], "default": "desc" - }, - "required": false, - "description": "The direction of the sort. Can be either `asc` or `desc`." + } }, { "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/lock.json b/openapi/ghe-2.17/operations/issues/lock.json index c092ef676e..218cf88e88 100644 --- a/openapi/ghe-2.17/operations/issues/lock.json +++ b/openapi/ghe-2.17/operations/issues/lock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -85,8 +85,8 @@ "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", + "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`", "enum": [ "off-topic", "too heated", diff --git a/openapi/ghe-2.17/operations/issues/remove-assignees.json b/openapi/ghe-2.17/operations/issues/remove-assignees.json index 96baf043a8..9d1b0e8912 100644 --- a/openapi/ghe-2.17/operations/issues/remove-assignees.json +++ b/openapi/ghe-2.17/operations/issues/remove-assignees.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -483,8 +483,8 @@ "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/issues/remove-label.json b/openapi/ghe-2.17/operations/issues/remove-label.json index 4ee41f6d39..b20e863b0a 100644 --- a/openapi/ghe-2.17/operations/issues/remove-label.json +++ b/openapi/ghe-2.17/operations/issues/remove-label.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "name", + "description": "name parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "name parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/remove-labels.json b/openapi/ghe-2.17/operations/issues/remove-labels.json index 819160fd14..ce57e200d8 100644 --- a/openapi/ghe-2.17/operations/issues/remove-labels.json +++ b/openapi/ghe-2.17/operations/issues/remove-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/replace-labels.json b/openapi/ghe-2.17/operations/issues/replace-labels.json index 5bdc560535..37b0c339dc 100644 --- a/openapi/ghe-2.17/operations/issues/replace-labels.json +++ b/openapi/ghe-2.17/operations/issues/replace-labels.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -118,8 +118,8 @@ "type": "object", "properties": { "labels": { - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "type": "array", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/issues/unlock.json b/openapi/ghe-2.17/operations/issues/unlock.json index 9f392b4475..d87908ad71 100644 --- a/openapi/ghe-2.17/operations/issues/unlock.json +++ b/openapi/ghe-2.17/operations/issues/unlock.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/issues/update-comment.json b/openapi/ghe-2.17/operations/issues/update-comment.json index 56c7a6f6c0..3ced9559f1 100644 --- a/openapi/ghe-2.17/operations/issues/update-comment.json +++ b/openapi/ghe-2.17/operations/issues/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -164,8 +164,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/issues/update-milestone.json b/openapi/ghe-2.17/operations/issues/update-milestone.json index 919db328ce..bf48e76e1f 100644 --- a/openapi/ghe-2.17/operations/issues/update-milestone.json +++ b/openapi/ghe-2.17/operations/issues/update-milestone.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "milestone_number", + "description": "milestone_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "milestone_number parameter" + } } ], "responses": { @@ -198,12 +198,12 @@ "type": "object", "properties": { "title": { - "description": "The title of the milestone.", - "type": "string" + "type": "string", + "description": "The title of the milestone." }, "state": { - "description": "The state of the milestone. Either `open` or `closed`.", "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", "enum": [ "open", "closed" @@ -211,12 +211,12 @@ "default": "open" }, "description": { - "description": "A description of the milestone.", - "type": "string" + "type": "string", + "description": "A description of the milestone." }, "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" + "type": "string", + "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`." } } } diff --git a/openapi/ghe-2.17/operations/issues/update.json b/openapi/ghe-2.17/operations/issues/update.json index 44b1724430..db630fa548 100644 --- a/openapi/ghe-2.17/operations/issues/update.json +++ b/openapi/ghe-2.17/operations/issues/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -542,40 +542,40 @@ "type": "object", "properties": { "title": { - "description": "The title of the issue.", - "type": "string" + "type": "string", + "description": "The title of the issue." }, "body": { - "description": "The contents of the issue.", - "type": "string" + "type": "string", + "description": "The contents of the issue." }, "assignee": { - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "type": "string" + "type": "string", + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**" }, "state": { - "description": "State of the issue. Either `open` or `closed`.", "type": "string", + "description": "State of the issue. Either `open` or `closed`.", "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", + "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._", "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", + "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._", "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", + "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._", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/licenses/get-for-repo.json b/openapi/ghe-2.17/operations/licenses/get-for-repo.json index 60e0dc36ae..f7868c07c2 100644 --- a/openapi/ghe-2.17/operations/licenses/get-for-repo.json +++ b/openapi/ghe-2.17/operations/licenses/get-for-repo.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/licenses/get.json b/openapi/ghe-2.17/operations/licenses/get.json index e862b1200f..6a0496758b 100644 --- a/openapi/ghe-2.17/operations/licenses/get.json +++ b/openapi/ghe-2.17/operations/licenses/get.json @@ -21,12 +21,12 @@ }, { "name": "license", + "description": "license parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "license parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/markdown/render.json b/openapi/ghe-2.17/operations/markdown/render.json index a17652bd55..912621c1f9 100644 --- a/openapi/ghe-2.17/operations/markdown/render.json +++ b/openapi/ghe-2.17/operations/markdown/render.json @@ -48,12 +48,12 @@ "type": "object", "properties": { "text": { - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "type": "string" + "type": "string", + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less." }, "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", + "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.", "enum": [ "markdown", "gfm" @@ -61,8 +61,8 @@ "default": "markdown" }, "context": { - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", - "type": "string" + "type": "string", + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/check-authorization.json b/openapi/ghe-2.17/operations/oauth-authorizations/check-authorization.json index 63014d83c5..0c8bbb4cd1 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/check-authorization.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/check-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/create-authorization.json b/openapi/ghe-2.17/operations/oauth-authorizations/create-authorization.json index 67e5fd352a..e0ce22bf08 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/create-authorization.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/create-authorization.json @@ -107,31 +107,31 @@ "type": "object", "properties": { "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "client_id": { - "description": "The 20 character OAuth app client key for which to create the token.", - "type": "string" + "type": "string", + "description": "The 20 character OAuth app client key for which to create the token." }, "client_secret": { - "description": "The 40 character OAuth app client secret for which to create the token.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret for which to create the token." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/delete-authorization.json b/openapi/ghe-2.17/operations/oauth-authorizations/delete-authorization.json index ee19d01a0a..e2f65bb385 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/delete-authorization.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/delete-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/delete-grant.json b/openapi/ghe-2.17/operations/oauth-authorizations/delete-grant.json index 74844a55f6..0003bfcc28 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/delete-grant.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/delete-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/get-authorization.json b/openapi/ghe-2.17/operations/oauth-authorizations/get-authorization.json index db58c36264..089de7affa 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/get-authorization.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/get-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/get-grant.json b/openapi/ghe-2.17/operations/oauth-authorizations/get-grant.json index 102f320c0a..61c6431f7b 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/get-grant.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/get-grant.json @@ -21,12 +21,12 @@ }, { "name": "grant_id", + "description": "grant_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "grant_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json b/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json index 2c46e39837..05e1653187 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "fingerprint", + "description": "fingerprint parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "fingerprint parameter" + } } ], "responses": { @@ -80,23 +80,23 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app.json b/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app.json index 7f3dd97bce..1cd7bbdb0d 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/get-or-create-authorization-for-app.json @@ -21,12 +21,12 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } } ], "responses": { @@ -57,27 +57,27 @@ "type": "object", "properties": { "client_secret": { - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "type": "string" + "type": "string", + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL." }, "scopes": { - "description": "A list of scopes that this authorization is in.", "type": "array", + "description": "A list of scopes that this authorization is in.", "items": { "type": "string" } }, "note": { - "description": "A note to remind you what the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A note to remind you what the OAuth token is for." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "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.17/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", - "type": "string" + "type": "string", + "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.17/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint)." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/list-authorizations.json b/openapi/ghe-2.17/operations/oauth-authorizations/list-authorizations.json index ae3176ee07..ef4a1a56c8 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/list-authorizations.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/list-authorizations.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/list-grants.json b/openapi/ghe-2.17/operations/oauth-authorizations/list-grants.json index 7b044cfb17..add902c685 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/list-grants.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/list-grants.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/reset-authorization.json b/openapi/ghe-2.17/operations/oauth-authorizations/reset-authorization.json index 636231ac2f..6d1e0f971e 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/reset-authorization.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/reset-authorization.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/revoke-authorization-for-application.json b/openapi/ghe-2.17/operations/oauth-authorizations/revoke-authorization-for-application.json index a01ffc8de9..4882c89a37 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/revoke-authorization-for-application.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/revoke-authorization-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/revoke-grant-for-application.json b/openapi/ghe-2.17/operations/oauth-authorizations/revoke-grant-for-application.json index ed93df48e3..b3d7e7ebfc 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/revoke-grant-for-application.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/revoke-grant-for-application.json @@ -21,21 +21,21 @@ }, { "name": "client_id", + "description": "client_id parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "client_id parameter" + } }, { "name": "access_token", + "description": "access_token parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "access_token parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/oauth-authorizations/update-authorization.json b/openapi/ghe-2.17/operations/oauth-authorizations/update-authorization.json index b74ded514b..20013ea5c9 100644 --- a/openapi/ghe-2.17/operations/oauth-authorizations/update-authorization.json +++ b/openapi/ghe-2.17/operations/oauth-authorizations/update-authorization.json @@ -21,12 +21,12 @@ }, { "name": "authorization_id", + "description": "authorization_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "authorization_id parameter" + } } ], "responses": { @@ -116,37 +116,37 @@ "type": "object", "properties": { "scopes": { - "description": "Replaces the authorization scopes with these.", "type": "array", + "description": "Replaces the authorization scopes with these.", "items": { "type": "string" } }, "add_scopes": { - "description": "A list of scopes to add to this authorization.", "type": "array", + "description": "A list of scopes to add to this authorization.", "items": { "type": "string" } }, "remove_scopes": { - "description": "A list of scopes to remove from this authorization.", "type": "array", + "description": "A list of scopes to remove from this authorization.", "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" + "type": "string", + "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." }, "note_url": { - "description": "A URL to remind you what app the OAuth token is for.", - "type": "string" + "type": "string", + "description": "A URL to remind you what app the OAuth token is for." }, "fingerprint": { - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "type": "string" + "type": "string", + "description": "A unique string to distinguish an authorization from others created for the same client ID and user." } } } diff --git a/openapi/ghe-2.17/operations/orgs/add-or-update-membership.json b/openapi/ghe-2.17/operations/orgs/add-or-update-membership.json index 9762505696..ab880458e3 100644 --- a/openapi/ghe-2.17/operations/orgs/add-or-update-membership.json +++ b/openapi/ghe-2.17/operations/orgs/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -187,8 +187,8 @@ "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", + "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.", "enum": [ "admin", "member" diff --git a/openapi/ghe-2.17/operations/orgs/check-membership.json b/openapi/ghe-2.17/operations/orgs/check-membership.json index 1844ce4b46..0da98ae013 100644 --- a/openapi/ghe-2.17/operations/orgs/check-membership.json +++ b/openapi/ghe-2.17/operations/orgs/check-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/check-public-membership.json b/openapi/ghe-2.17/operations/orgs/check-public-membership.json index e2400cb214..89d3541e8a 100644 --- a/openapi/ghe-2.17/operations/orgs/check-public-membership.json +++ b/openapi/ghe-2.17/operations/orgs/check-public-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/conceal-membership.json b/openapi/ghe-2.17/operations/orgs/conceal-membership.json index 4e89693cbe..0ffd86bb55 100644 --- a/openapi/ghe-2.17/operations/orgs/conceal-membership.json +++ b/openapi/ghe-2.17/operations/orgs/conceal-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/convert-member-to-outside-collaborator.json b/openapi/ghe-2.17/operations/orgs/convert-member-to-outside-collaborator.json index 0374292e62..9c3ac227d1 100644 --- a/openapi/ghe-2.17/operations/orgs/convert-member-to-outside-collaborator.json +++ b/openapi/ghe-2.17/operations/orgs/convert-member-to-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/create-hook.json b/openapi/ghe-2.17/operations/orgs/create-hook.json index 6a77796d5e..dbdecf68d0 100644 --- a/openapi/ghe-2.17/operations/orgs/create-hook.json +++ b/openapi/ghe-2.17/operations/orgs/create-hook.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -104,28 +104,28 @@ "type": "object", "properties": { "name": { - "description": "Must be passed as \"web\".", - "type": "string" + "type": "string", + "description": "Must be passed as \"web\"." }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.17/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.17/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -133,8 +133,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -143,8 +143,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/orgs/delete-hook.json b/openapi/ghe-2.17/operations/orgs/delete-hook.json index 35e392d222..9202e7243d 100644 --- a/openapi/ghe-2.17/operations/orgs/delete-hook.json +++ b/openapi/ghe-2.17/operations/orgs/delete-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/get-hook.json b/openapi/ghe-2.17/operations/orgs/get-hook.json index aa3182db98..d10dd8188e 100644 --- a/openapi/ghe-2.17/operations/orgs/get-hook.json +++ b/openapi/ghe-2.17/operations/orgs/get-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/get-membership-for-authenticated-user.json b/openapi/ghe-2.17/operations/orgs/get-membership-for-authenticated-user.json index bd70dd7593..fae1176d8e 100644 --- a/openapi/ghe-2.17/operations/orgs/get-membership-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/orgs/get-membership-for-authenticated-user.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/get-membership.json b/openapi/ghe-2.17/operations/orgs/get-membership.json index 2ba0579941..1c36ac65bc 100644 --- a/openapi/ghe-2.17/operations/orgs/get-membership.json +++ b/openapi/ghe-2.17/operations/orgs/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/get.json b/openapi/ghe-2.17/operations/orgs/get.json index f589ef3148..291876c873 100644 --- a/openapi/ghe-2.17/operations/orgs/get.json +++ b/openapi/ghe-2.17/operations/orgs/get.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-for-authenticated-user.json b/openapi/ghe-2.17/operations/orgs/list-for-authenticated-user.json index 0338728b93..3a37dd4d50 100644 --- a/openapi/ghe-2.17/operations/orgs/list-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/orgs/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-for-user.json b/openapi/ghe-2.17/operations/orgs/list-for-user.json index 98de020861..2f823e2a9c 100644 --- a/openapi/ghe-2.17/operations/orgs/list-for-user.json +++ b/openapi/ghe-2.17/operations/orgs/list-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-hooks.json b/openapi/ghe-2.17/operations/orgs/list-hooks.json index 32cbfe1981..a6cf210042 100644 --- a/openapi/ghe-2.17/operations/orgs/list-hooks.json +++ b/openapi/ghe-2.17/operations/orgs/list-hooks.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-members.json b/openapi/ghe-2.17/operations/orgs/list-members.json index f54a012843..82ec03f235 100644 --- a/openapi/ghe-2.17/operations/orgs/list-members.json +++ b/openapi/ghe-2.17/operations/orgs/list-members.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "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", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-memberships.json b/openapi/ghe-2.17/operations/orgs/list-memberships.json index c76efb9f98..b9fe199cf2 100644 --- a/openapi/ghe-2.17/operations/orgs/list-memberships.json +++ b/openapi/ghe-2.17/operations/orgs/list-memberships.json @@ -21,36 +21,34 @@ }, { "name": "state", + "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.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-outside-collaborators.json b/openapi/ghe-2.17/operations/orgs/list-outside-collaborators.json index d8f27602e5..312dbb1bae 100644 --- a/openapi/ghe-2.17/operations/orgs/list-outside-collaborators.json +++ b/openapi/ghe-2.17/operations/orgs/list-outside-collaborators.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,29 +40,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list-public-members.json b/openapi/ghe-2.17/operations/orgs/list-public-members.json index 00b22a3c1c..408d8c9b48 100644 --- a/openapi/ghe-2.17/operations/orgs/list-public-members.json +++ b/openapi/ghe-2.17/operations/orgs/list-public-members.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/list.json b/openapi/ghe-2.17/operations/orgs/list.json index 76859105df..d845552c95 100644 --- a/openapi/ghe-2.17/operations/orgs/list.json +++ b/openapi/ghe-2.17/operations/orgs/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last Organization that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Organization that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/ping-hook.json b/openapi/ghe-2.17/operations/orgs/ping-hook.json index d9b1e8bf77..29e9186157 100644 --- a/openapi/ghe-2.17/operations/orgs/ping-hook.json +++ b/openapi/ghe-2.17/operations/orgs/ping-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/publicize-membership.json b/openapi/ghe-2.17/operations/orgs/publicize-membership.json index 6260ba1577..005bcdda17 100644 --- a/openapi/ghe-2.17/operations/orgs/publicize-membership.json +++ b/openapi/ghe-2.17/operations/orgs/publicize-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/remove-member.json b/openapi/ghe-2.17/operations/orgs/remove-member.json index 3bfc8672fe..43165649a4 100644 --- a/openapi/ghe-2.17/operations/orgs/remove-member.json +++ b/openapi/ghe-2.17/operations/orgs/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/remove-membership.json b/openapi/ghe-2.17/operations/orgs/remove-membership.json index c81372a807..78be92fd77 100644 --- a/openapi/ghe-2.17/operations/orgs/remove-membership.json +++ b/openapi/ghe-2.17/operations/orgs/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/remove-outside-collaborator.json b/openapi/ghe-2.17/operations/orgs/remove-outside-collaborator.json index 7f7270485d..fb17a4db07 100644 --- a/openapi/ghe-2.17/operations/orgs/remove-outside-collaborator.json +++ b/openapi/ghe-2.17/operations/orgs/remove-outside-collaborator.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/orgs/update-hook.json b/openapi/ghe-2.17/operations/orgs/update-hook.json index 8a60770ffc..342dc8e3b9 100644 --- a/openapi/ghe-2.17/operations/orgs/update-hook.json +++ b/openapi/ghe-2.17/operations/orgs/update-hook.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -113,24 +113,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#update-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#update-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.17/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.17/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -138,8 +138,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -148,8 +148,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.17/operations/orgs/update-membership.json b/openapi/ghe-2.17/operations/orgs/update-membership.json index 6280cf56e7..6a96788518 100644 --- a/openapi/ghe-2.17/operations/orgs/update-membership.json +++ b/openapi/ghe-2.17/operations/orgs/update-membership.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -178,8 +178,8 @@ "type": "object", "properties": { "state": { - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "type": "string", + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", "enum": [ "active" ] diff --git a/openapi/ghe-2.17/operations/orgs/update.json b/openapi/ghe-2.17/operations/orgs/update.json index b54a1bba6d..990a080357 100644 --- a/openapi/ghe-2.17/operations/orgs/update.json +++ b/openapi/ghe-2.17/operations/orgs/update.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -185,40 +185,40 @@ "type": "object", "properties": { "billing_email": { - "description": "Billing email address. This address is not publicized.", - "type": "string" + "type": "string", + "description": "Billing email address. This address is not publicized." }, "company": { - "description": "The company name.", - "type": "string" + "type": "string", + "description": "The company name." }, "email": { - "description": "The publicly visible email address.", - "type": "string" + "type": "string", + "description": "The publicly visible email address." }, "location": { - "description": "The location.", - "type": "string" + "type": "string", + "description": "The location." }, "name": { - "description": "The shorthand name of the company.", - "type": "string" + "type": "string", + "description": "The shorthand name of the company." }, "description": { - "description": "The description of the company.", - "type": "string" + "type": "string", + "description": "The description of the company." }, "has_organization_projects": { - "description": "Toggles whether organization projects are enabled for the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether organization projects are enabled for the organization." }, "has_repository_projects": { - "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", - "type": "boolean" + "type": "boolean", + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization." }, "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", + "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.", "enum": [ "read", "write", @@ -228,13 +228,13 @@ "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. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details.", "type": "boolean", + "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. \nDefault: `true` \n**Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details. **Note:** Another parameter can override the this parameter. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details.", "default": true }, "members_allowed_repository_creation_type": { - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details.", "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on [GitHub Business Cloud](https://github.com/pricing/business-cloud). \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter will override values set in `members_can_create_repositories`. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details.", "enum": [ "all", "private", diff --git a/openapi/ghe-2.17/operations/projects/add-collaborator.json b/openapi/ghe-2.17/operations/projects/add-collaborator.json index be124532d1..ee5987aa28 100644 --- a/openapi/ghe-2.17/operations/projects/add-collaborator.json +++ b/openapi/ghe-2.17/operations/projects/add-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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.17/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", + "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.17/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.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.17/operations/projects/create-card.json b/openapi/ghe-2.17/operations/projects/create-card.json index 7de9a51233..0d447ff807 100644 --- a/openapi/ghe-2.17/operations/projects/create-card.json +++ b/openapi/ghe-2.17/operations/projects/create-card.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -156,16 +156,16 @@ "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" + "type": "string", + "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`." }, "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.17/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.17/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" + "type": "integer", + "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.17/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.17/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`." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.17/operations/projects/create-column.json b/openapi/ghe-2.17/operations/projects/create-column.json index baf26e3d6b..471d9f40e0 100644 --- a/openapi/ghe-2.17/operations/projects/create-column.json +++ b/openapi/ghe-2.17/operations/projects/create-column.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The name of the column.", - "type": "string" + "type": "string", + "description": "The name of the column." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/projects/create-for-authenticated-user.json b/openapi/ghe-2.17/operations/projects/create-for-authenticated-user.json index c4db41f987..171dec566c 100644 --- a/openapi/ghe-2.17/operations/projects/create-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/projects/create-for-authenticated-user.json @@ -22,23 +22,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -173,12 +171,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/projects/create-for-org.json b/openapi/ghe-2.17/operations/projects/create-for-org.json index cf94954f7c..7bfbc9cb21 100644 --- a/openapi/ghe-2.17/operations/projects/create-for-org.json +++ b/openapi/ghe-2.17/operations/projects/create-for-org.json @@ -22,32 +22,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,12 +180,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/projects/create-for-repo.json b/openapi/ghe-2.17/operations/projects/create-for-repo.json index d1b1ab4165..2dff0b13d0 100644 --- a/openapi/ghe-2.17/operations/projects/create-for-repo.json +++ b/openapi/ghe-2.17/operations/projects/create-for-repo.json @@ -22,41 +22,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -191,12 +189,12 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/projects/delete-card.json b/openapi/ghe-2.17/operations/projects/delete-card.json index 10303d717c..e015dfb260 100644 --- a/openapi/ghe-2.17/operations/projects/delete-card.json +++ b/openapi/ghe-2.17/operations/projects/delete-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/delete-column.json b/openapi/ghe-2.17/operations/projects/delete-column.json index 4d65d650a2..8b39f284a1 100644 --- a/openapi/ghe-2.17/operations/projects/delete-column.json +++ b/openapi/ghe-2.17/operations/projects/delete-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/delete.json b/openapi/ghe-2.17/operations/projects/delete.json index ce5fdad7d0..6c1f8bd8de 100644 --- a/openapi/ghe-2.17/operations/projects/delete.json +++ b/openapi/ghe-2.17/operations/projects/delete.json @@ -22,12 +22,12 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/get-card.json b/openapi/ghe-2.17/operations/projects/get-card.json index 207ef50e41..07bb37a29d 100644 --- a/openapi/ghe-2.17/operations/projects/get-card.json +++ b/openapi/ghe-2.17/operations/projects/get-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/get-column.json b/openapi/ghe-2.17/operations/projects/get-column.json index d7be80dd95..e560cf9a55 100644 --- a/openapi/ghe-2.17/operations/projects/get-column.json +++ b/openapi/ghe-2.17/operations/projects/get-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/get.json b/openapi/ghe-2.17/operations/projects/get.json index 40ab4b73e1..9b9a990b56 100644 --- a/openapi/ghe-2.17/operations/projects/get.json +++ b/openapi/ghe-2.17/operations/projects/get.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/list-cards.json b/openapi/ghe-2.17/operations/projects/list-cards.json index a3d100c5d3..e4da6945ef 100644 --- a/openapi/ghe-2.17/operations/projects/list-cards.json +++ b/openapi/ghe-2.17/operations/projects/list-cards.json @@ -22,16 +22,18 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } }, { "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "not_archived" ], "default": "not_archived" - }, - "required": false, - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/list-collaborators.json b/openapi/ghe-2.17/operations/projects/list-collaborators.json index ccae670ea6..f23ddc44ae 100644 --- a/openapi/ghe-2.17/operations/projects/list-collaborators.json +++ b/openapi/ghe-2.17/operations/projects/list-collaborators.json @@ -22,16 +22,18 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/list-columns.json b/openapi/ghe-2.17/operations/projects/list-columns.json index 1a68488264..f3963b0bd1 100644 --- a/openapi/ghe-2.17/operations/projects/list-columns.json +++ b/openapi/ghe-2.17/operations/projects/list-columns.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/list-for-org.json b/openapi/ghe-2.17/operations/projects/list-for-org.json index 3ecaa6b5a1..88dfadb77d 100644 --- a/openapi/ghe-2.17/operations/projects/list-for-org.json +++ b/openapi/ghe-2.17/operations/projects/list-for-org.json @@ -22,16 +22,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/list-for-repo.json b/openapi/ghe-2.17/operations/projects/list-for-repo.json index 6be61a4a97..ba58ca2037 100644 --- a/openapi/ghe-2.17/operations/projects/list-for-repo.json +++ b/openapi/ghe-2.17/operations/projects/list-for-repo.json @@ -22,25 +22,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -49,29 +51,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/list-for-user.json b/openapi/ghe-2.17/operations/projects/list-for-user.json index 7539de2742..c2810fccbf 100644 --- a/openapi/ghe-2.17/operations/projects/list-for-user.json +++ b/openapi/ghe-2.17/operations/projects/list-for-user.json @@ -22,16 +22,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,29 +42,25 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/move-card.json b/openapi/ghe-2.17/operations/projects/move-card.json index 63abfa3752..465044f164 100644 --- a/openapi/ghe-2.17/operations/projects/move-card.json +++ b/openapi/ghe-2.17/operations/projects/move-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,13 +58,13 @@ "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", + "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`.", "pattern": "^(top|bottom|after:\\d+)$" }, "column_id": { - "description": "The `id` value of a column in the same project.", - "type": "integer" + "type": "integer", + "description": "The `id` value of a column in the same project." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/projects/move-column.json b/openapi/ghe-2.17/operations/projects/move-column.json index 8b3a2efe0d..9d8638d55b 100644 --- a/openapi/ghe-2.17/operations/projects/move-column.json +++ b/openapi/ghe-2.17/operations/projects/move-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "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", + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", "pattern": "^(first|last|after:\\d+)$" } }, diff --git a/openapi/ghe-2.17/operations/projects/remove-collaborator.json b/openapi/ghe-2.17/operations/projects/remove-collaborator.json index 7cd0b951bc..70f6ee9bdc 100644 --- a/openapi/ghe-2.17/operations/projects/remove-collaborator.json +++ b/openapi/ghe-2.17/operations/projects/remove-collaborator.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/review-user-permission-level.json b/openapi/ghe-2.17/operations/projects/review-user-permission-level.json index eef9f8b426..162307e2a4 100644 --- a/openapi/ghe-2.17/operations/projects/review-user-permission-level.json +++ b/openapi/ghe-2.17/operations/projects/review-user-permission-level.json @@ -22,21 +22,21 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/projects/update-card.json b/openapi/ghe-2.17/operations/projects/update-card.json index 96af09f07b..654a5c467e 100644 --- a/openapi/ghe-2.17/operations/projects/update-card.json +++ b/openapi/ghe-2.17/operations/projects/update-card.json @@ -22,12 +22,12 @@ }, { "name": "card_id", + "description": "card_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "card_id parameter" + } } ], "responses": { @@ -58,12 +58,12 @@ "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" + "type": "string", + "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`." }, "archived": { - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "type": "boolean" + "type": "boolean", + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card." } } } diff --git a/openapi/ghe-2.17/operations/projects/update-column.json b/openapi/ghe-2.17/operations/projects/update-column.json index 78c59450d3..1dea7c3cc7 100644 --- a/openapi/ghe-2.17/operations/projects/update-column.json +++ b/openapi/ghe-2.17/operations/projects/update-column.json @@ -22,12 +22,12 @@ }, { "name": "column_id", + "description": "column_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "column_id parameter" + } } ], "responses": { @@ -58,8 +58,8 @@ "type": "object", "properties": { "name": { - "description": "The new name of the column.", - "type": "string" + "type": "string", + "description": "The new name of the column." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/projects/update.json b/openapi/ghe-2.17/operations/projects/update.json index 5c8acf129d..3609e3f37e 100644 --- a/openapi/ghe-2.17/operations/projects/update.json +++ b/openapi/ghe-2.17/operations/projects/update.json @@ -22,32 +22,30 @@ }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { @@ -182,28 +180,28 @@ "type": "object", "properties": { "name": { - "description": "The name of the project.", - "type": "string" + "type": "string", + "description": "The name of the project." }, "body": { - "description": "The description of the project.", - "type": "string" + "type": "string", + "description": "The description of the project." }, "state": { - "description": "State of the project. Either `open` or `closed`.", "type": "string", + "description": "State of the project. Either `open` or `closed`.", "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.17/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.17/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" + "type": "string", + "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.17/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.17/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." }, "private": { - "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", - "type": "boolean" + "type": "boolean", + "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account." } } } diff --git a/openapi/ghe-2.17/operations/pulls/check-if-merged.json b/openapi/ghe-2.17/operations/pulls/check-if-merged.json index a05fc4cc02..f630f876ba 100644 --- a/openapi/ghe-2.17/operations/pulls/check-if-merged.json +++ b/openapi/ghe-2.17/operations/pulls/check-if-merged.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/create-comment-reply.json b/openapi/ghe-2.17/operations/pulls/create-comment-reply.json index 92b24deb29..972fa85b22 100644 --- a/openapi/ghe-2.17/operations/pulls/create-comment-reply.json +++ b/openapi/ghe-2.17/operations/pulls/create-comment-reply.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,12 +231,12 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/create-comment.json b/openapi/ghe-2.17/operations/pulls/create-comment.json index 5af4163efe..b3d28a4ede 100644 --- a/openapi/ghe-2.17/operations/pulls/create-comment.json +++ b/openapi/ghe-2.17/operations/pulls/create-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -231,20 +231,20 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." }, "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" + "type": "string", + "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`." }, "path": { - "description": "The relative path to the file that necessitates a comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a comment." }, "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/create-from-issue.json b/openapi/ghe-2.17/operations/pulls/create-from-issue.json index e823b22187..66f6f858e3 100644 --- a/openapi/ghe-2.17/operations/pulls/create-from-issue.json +++ b/openapi/ghe-2.17/operations/pulls/create-from-issue.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1508,24 +1508,24 @@ "type": "object", "properties": { "issue": { - "description": "The issue number in this repository to turn into a Pull Request.", - "type": "integer" + "type": "integer", + "description": "The issue number in this repository to turn into a Pull Request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." }, "draft": { - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "type": "boolean" + "type": "boolean", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/create-review-request.json b/openapi/ghe-2.17/operations/pulls/create-review-request.json index 9f6a46fb4a..f15f3ae52c 100644 --- a/openapi/ghe-2.17/operations/pulls/create-review-request.json +++ b/openapi/ghe-2.17/operations/pulls/create-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1455,15 +1455,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be requested.", "type": "array", + "description": "An array of user `login`s that will be requested.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be requested.", "type": "array", + "description": "An array of team `slug`s that will be requested.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/pulls/create-review.json b/openapi/ghe-2.17/operations/pulls/create-review.json index 39b837b747..ef050ded98 100644 --- a/openapi/ghe-2.17/operations/pulls/create-review.json +++ b/openapi/ghe-2.17/operations/pulls/create-review.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -196,16 +196,16 @@ "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" + "type": "string", + "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." }, "body": { - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "type": "string" + "type": "string", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." }, "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.17/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "type": "string", + "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.17/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -213,22 +213,22 @@ ] }, "comments": { - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "type": "array", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", "items": { "type": "object", "properties": { "path": { - "description": "The relative path to the file that necessitates a review comment.", - "type": "string" + "type": "string", + "description": "The relative path to the file that necessitates a review comment." }, "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" + "type": "integer", + "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." }, "body": { - "description": "Text of the review comment.", - "type": "string" + "type": "string", + "description": "Text of the review comment." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/create.json b/openapi/ghe-2.17/operations/pulls/create.json index 45ba0d054b..7786559ea8 100644 --- a/openapi/ghe-2.17/operations/pulls/create.json +++ b/openapi/ghe-2.17/operations/pulls/create.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1508,28 +1508,28 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "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" + "type": "string", + "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`." }, "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" + "type": "string", + "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." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "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" + "type": "boolean", + "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." }, "draft": { - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "type": "boolean" + "type": "boolean", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/delete-comment.json b/openapi/ghe-2.17/operations/pulls/delete-comment.json index 543aebc08d..29112cf4a6 100644 --- a/openapi/ghe-2.17/operations/pulls/delete-comment.json +++ b/openapi/ghe-2.17/operations/pulls/delete-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/delete-pending-review.json b/openapi/ghe-2.17/operations/pulls/delete-pending-review.json index aab889bc62..24bdc381e0 100644 --- a/openapi/ghe-2.17/operations/pulls/delete-pending-review.json +++ b/openapi/ghe-2.17/operations/pulls/delete-pending-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/delete-review-request.json b/openapi/ghe-2.17/operations/pulls/delete-review-request.json index bd7a5d9234..81ba235dc1 100644 --- a/openapi/ghe-2.17/operations/pulls/delete-review-request.json +++ b/openapi/ghe-2.17/operations/pulls/delete-review-request.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -85,15 +85,15 @@ "type": "object", "properties": { "reviewers": { - "description": "An array of user `login`s that will be removed.", "type": "array", + "description": "An array of user `login`s that will be removed.", "items": { "type": "string" } }, "team_reviewers": { - "description": "An array of team `slug`s that will be removed.", "type": "array", + "description": "An array of team `slug`s that will be removed.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/pulls/dismiss-review.json b/openapi/ghe-2.17/operations/pulls/dismiss-review.json index 945a902ad4..e3c065799a 100644 --- a/openapi/ghe-2.17/operations/pulls/dismiss-review.json +++ b/openapi/ghe-2.17/operations/pulls/dismiss-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,8 +204,8 @@ "type": "object", "properties": { "message": { - "description": "The message for the pull request review dismissal", - "type": "string" + "type": "string", + "description": "The message for the pull request review dismissal" } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/get-comment.json b/openapi/ghe-2.17/operations/pulls/get-comment.json index 7bb2223de8..71e692fffd 100644 --- a/openapi/ghe-2.17/operations/pulls/get-comment.json +++ b/openapi/ghe-2.17/operations/pulls/get-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/get-comments-for-review.json b/openapi/ghe-2.17/operations/pulls/get-comments-for-review.json index 3cd3320b09..6df3bff6bc 100644 --- a/openapi/ghe-2.17/operations/pulls/get-comments-for-review.json +++ b/openapi/ghe-2.17/operations/pulls/get-comments-for-review.json @@ -21,59 +21,57 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/get-review.json b/openapi/ghe-2.17/operations/pulls/get-review.json index 9ed907cde1..223eeabacf 100644 --- a/openapi/ghe-2.17/operations/pulls/get-review.json +++ b/openapi/ghe-2.17/operations/pulls/get-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/get.json b/openapi/ghe-2.17/operations/pulls/get.json index 40153fd56b..0e62501a26 100644 --- a/openapi/ghe-2.17/operations/pulls/get.json +++ b/openapi/ghe-2.17/operations/pulls/get.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list-comments-for-repo.json b/openapi/ghe-2.17/operations/pulls/list-comments-for-repo.json index ef63b5fab1..b2031727d6 100644 --- a/openapi/ghe-2.17/operations/pulls/list-comments-for-repo.json +++ b/openapi/ghe-2.17/operations/pulls/list-comments-for-repo.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,51 +49,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list-comments.json b/openapi/ghe-2.17/operations/pulls/list-comments.json index c73e2ae7e1..f795ec2707 100644 --- a/openapi/ghe-2.17/operations/pulls/list-comments.json +++ b/openapi/ghe-2.17/operations/pulls/list-comments.json @@ -21,34 +21,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "sort", + "description": "Can be either `created` or `updated` comments.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,51 +58,47 @@ "updated" ], "default": "created" - }, - "required": false, - "description": "Can be either `created` or `updated` comments." + } }, { "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + } }, { "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list-commits.json b/openapi/ghe-2.17/operations/pulls/list-commits.json index 1aa632936f..3c3fe58c0b 100644 --- a/openapi/ghe-2.17/operations/pulls/list-commits.json +++ b/openapi/ghe-2.17/operations/pulls/list-commits.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list-files.json b/openapi/ghe-2.17/operations/pulls/list-files.json index be9c821807..3e3014c4fa 100644 --- a/openapi/ghe-2.17/operations/pulls/list-files.json +++ b/openapi/ghe-2.17/operations/pulls/list-files.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list-review-requests.json b/openapi/ghe-2.17/operations/pulls/list-review-requests.json index c7232ac33a..b6d2eaca49 100644 --- a/openapi/ghe-2.17/operations/pulls/list-review-requests.json +++ b/openapi/ghe-2.17/operations/pulls/list-review-requests.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list-reviews.json b/openapi/ghe-2.17/operations/pulls/list-reviews.json index f6dce8493c..adc8fcc4f7 100644 --- a/openapi/ghe-2.17/operations/pulls/list-reviews.json +++ b/openapi/ghe-2.17/operations/pulls/list-reviews.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/list.json b/openapi/ghe-2.17/operations/pulls/list.json index 485fe6264a..9caf890643 100644 --- a/openapi/ghe-2.17/operations/pulls/list.json +++ b/openapi/ghe-2.17/operations/pulls/list.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,31 +50,31 @@ "all" ], "default": "open" - }, - "required": false, - "description": "Either `open`, `closed`, or `all` to filter by state." + } }, { "name": "head", + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", "in": "query", + "required": false, "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", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter pulls by base branch name. Example: `gh-pages`." + } }, { "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -82,42 +84,38 @@ "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", + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/pulls/merge.json b/openapi/ghe-2.17/operations/pulls/merge.json index a4aa291e1d..9918997c92 100644 --- a/openapi/ghe-2.17/operations/pulls/merge.json +++ b/openapi/ghe-2.17/operations/pulls/merge.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -86,20 +86,20 @@ "type": "object", "properties": { "commit_title": { - "description": "Title for the automatic commit message.", - "type": "string" + "type": "string", + "description": "Title for the automatic commit message." }, "commit_message": { - "description": "Extra detail to append to automatic commit message.", - "type": "string" + "type": "string", + "description": "Extra detail to append to automatic commit message." }, "sha": { - "description": "SHA that pull request head must match to allow merge.", - "type": "string" + "type": "string", + "description": "SHA that pull request head must match to allow merge." }, "merge_method": { - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "type": "string", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "enum": [ "merge", "squash", diff --git a/openapi/ghe-2.17/operations/pulls/submit-review.json b/openapi/ghe-2.17/operations/pulls/submit-review.json index d42429de8a..52c79667a5 100644 --- a/openapi/ghe-2.17/operations/pulls/submit-review.json +++ b/openapi/ghe-2.17/operations/pulls/submit-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,12 +204,12 @@ "type": "object", "properties": { "body": { - "description": "The body text of the pull request review", - "type": "string" + "type": "string", + "description": "The body text of the pull request review" }, "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", + "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.", "enum": [ "APPROVE", "REQUEST_CHANGES", diff --git a/openapi/ghe-2.17/operations/pulls/update-comment.json b/openapi/ghe-2.17/operations/pulls/update-comment.json index e2cbfe85e6..df5491bf98 100644 --- a/openapi/ghe-2.17/operations/pulls/update-comment.json +++ b/openapi/ghe-2.17/operations/pulls/update-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -220,8 +220,8 @@ "type": "object", "properties": { "body": { - "description": "The text of the comment.", - "type": "string" + "type": "string", + "description": "The text of the comment." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/update-review.json b/openapi/ghe-2.17/operations/pulls/update-review.json index 211aa971e3..fb3dfb2dfe 100644 --- a/openapi/ghe-2.17/operations/pulls/update-review.json +++ b/openapi/ghe-2.17/operations/pulls/update-review.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } }, { "name": "review_id", + "description": "review_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "review_id parameter" + } } ], "responses": { @@ -204,8 +204,8 @@ "type": "object", "properties": { "body": { - "description": "The body text of the pull request review.", - "type": "string" + "type": "string", + "description": "The body text of the pull request review." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/pulls/update.json b/openapi/ghe-2.17/operations/pulls/update.json index 21cc671db7..08e18c97ce 100644 --- a/openapi/ghe-2.17/operations/pulls/update.json +++ b/openapi/ghe-2.17/operations/pulls/update.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "pull_number", + "description": "pull_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "pull_number parameter" + } } ], "responses": { @@ -1526,28 +1526,28 @@ "type": "object", "properties": { "title": { - "description": "The title of the pull request.", - "type": "string" + "type": "string", + "description": "The title of the pull request." }, "body": { - "description": "The contents of the pull request.", - "type": "string" + "type": "string", + "description": "The contents of the pull request." }, "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", "type": "string", + "description": "State of this Pull Request. Either `open` or `closed`.", "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" + "type": "string", + "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." }, "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" + "type": "boolean", + "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." } } } diff --git a/openapi/ghe-2.17/operations/reactions/create-for-commit-comment.json b/openapi/ghe-2.17/operations/reactions/create-for-commit-comment.json index ca3a4ced8b..f0240a2a82 100644 --- a/openapi/ghe-2.17/operations/reactions/create-for-commit-comment.json +++ b/openapi/ghe-2.17/operations/reactions/create-for-commit-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the commit comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the commit comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.17/operations/reactions/create-for-issue-comment.json b/openapi/ghe-2.17/operations/reactions/create-for-issue-comment.json index 033c65b916..26b3197d25 100644 --- a/openapi/ghe-2.17/operations/reactions/create-for-issue-comment.json +++ b/openapi/ghe-2.17/operations/reactions/create-for-issue-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the issue comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the issue comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.17/operations/reactions/create-for-issue.json b/openapi/ghe-2.17/operations/reactions/create-for-issue.json index 15c70df428..ddc229dadf 100644 --- a/openapi/ghe-2.17/operations/reactions/create-for-issue.json +++ b/openapi/ghe-2.17/operations/reactions/create-for-issue.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } } ], "responses": { @@ -166,8 +166,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the issue.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the issue.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.17/operations/reactions/create-for-pull-request-review-comment.json b/openapi/ghe-2.17/operations/reactions/create-for-pull-request-review-comment.json index 56ee9dfefa..6d569e0f9b 100644 --- a/openapi/ghe-2.17/operations/reactions/create-for-pull-request-review-comment.json +++ b/openapi/ghe-2.17/operations/reactions/create-for-pull-request-review-comment.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the pull request review comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the pull request review comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.17/operations/reactions/create-for-team-discussion-comment.json b/openapi/ghe-2.17/operations/reactions/create-for-team-discussion-comment.json index 04289acea4..6c3ac92bd1 100644 --- a/openapi/ghe-2.17/operations/reactions/create-for-team-discussion-comment.json +++ b/openapi/ghe-2.17/operations/reactions/create-for-team-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -156,8 +156,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the team discussion comment.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the team discussion comment.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.17/operations/reactions/create-for-team-discussion.json b/openapi/ghe-2.17/operations/reactions/create-for-team-discussion.json index 84d60eba63..988a26adb8 100644 --- a/openapi/ghe-2.17/operations/reactions/create-for-team-discussion.json +++ b/openapi/ghe-2.17/operations/reactions/create-for-team-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -147,8 +147,8 @@ "type": "object", "properties": { "content": { - "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the team discussion.", "type": "string", + "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the team discussion.", "enum": [ "+1", "-1", diff --git a/openapi/ghe-2.17/operations/reactions/delete.json b/openapi/ghe-2.17/operations/reactions/delete.json index 4ef9641e2a..0fc94ecd47 100644 --- a/openapi/ghe-2.17/operations/reactions/delete.json +++ b/openapi/ghe-2.17/operations/reactions/delete.json @@ -22,12 +22,12 @@ }, { "name": "reaction_id", + "description": "reaction_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "reaction_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/reactions/list-for-commit-comment.json b/openapi/ghe-2.17/operations/reactions/list-for-commit-comment.json index c54132b011..916974a7f5 100644 --- a/openapi/ghe-2.17/operations/reactions/list-for-commit-comment.json +++ b/openapi/ghe-2.17/operations/reactions/list-for-commit-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/reactions/list-for-issue-comment.json b/openapi/ghe-2.17/operations/reactions/list-for-issue-comment.json index df1f0fb359..5bf96886b1 100644 --- a/openapi/ghe-2.17/operations/reactions/list-for-issue-comment.json +++ b/openapi/ghe-2.17/operations/reactions/list-for-issue-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/reactions/list-for-issue.json b/openapi/ghe-2.17/operations/reactions/list-for-issue.json index 84dcb24f66..15e3a145fc 100644 --- a/openapi/ghe-2.17/operations/reactions/list-for-issue.json +++ b/openapi/ghe-2.17/operations/reactions/list-for-issue.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "issue_number", + "description": "issue_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "issue_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/reactions/list-for-pull-request-review-comment.json b/openapi/ghe-2.17/operations/reactions/list-for-pull-request-review-comment.json index 846b22359e..13dcdc6b69 100644 --- a/openapi/ghe-2.17/operations/reactions/list-for-pull-request-review-comment.json +++ b/openapi/ghe-2.17/operations/reactions/list-for-pull-request-review-comment.json @@ -22,34 +22,36 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/reactions/list-for-team-discussion-comment.json b/openapi/ghe-2.17/operations/reactions/list-for-team-discussion-comment.json index 2ba379d386..f1fef8ae67 100644 --- a/openapi/ghe-2.17/operations/reactions/list-for-team-discussion-comment.json +++ b/openapi/ghe-2.17/operations/reactions/list-for-team-discussion-comment.json @@ -22,34 +22,36 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -62,29 +64,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/reactions/list-for-team-discussion.json b/openapi/ghe-2.17/operations/reactions/list-for-team-discussion.json index 32a1ebb469..6072e0546e 100644 --- a/openapi/ghe-2.17/operations/reactions/list-for-team-discussion.json +++ b/openapi/ghe-2.17/operations/reactions/list-for-team-discussion.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "rocket", "eyes" ] - }, - "required": false, - "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/accept-invitation.json b/openapi/ghe-2.17/operations/repos/accept-invitation.json index e024ad3c79..91affc6851 100644 --- a/openapi/ghe-2.17/operations/repos/accept-invitation.json +++ b/openapi/ghe-2.17/operations/repos/accept-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/add-collaborator.json b/openapi/ghe-2.17/operations/repos/add-collaborator.json index 335713f30a..c5f6754807 100644 --- a/openapi/ghe-2.17/operations/repos/add-collaborator.json +++ b/openapi/ghe-2.17/operations/repos/add-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -76,8 +76,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/ghe-2.17/operations/repos/add-deploy-key.json b/openapi/ghe-2.17/operations/repos/add-deploy-key.json index 35df132f14..6a4bae16af 100644 --- a/openapi/ghe-2.17/operations/repos/add-deploy-key.json +++ b/openapi/ghe-2.17/operations/repos/add-deploy-key.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -96,16 +96,16 @@ "type": "object", "properties": { "title": { - "description": "A name for the key.", - "type": "string" + "type": "string", + "description": "A name for the key." }, "key": { - "description": "The contents of the key.", - "type": "string" + "type": "string", + "description": "The contents of the key." }, "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" + "type": "boolean", + "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/).\"" } }, "required": [ diff --git a/openapi/ghe-2.17/operations/repos/add-protected-branch-admin-enforcement.json b/openapi/ghe-2.17/operations/repos/add-protected-branch-admin-enforcement.json index b7bc3859b3..fb84aa029e 100644 --- a/openapi/ghe-2.17/operations/repos/add-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.17/operations/repos/add-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/add-protected-branch-required-signatures.json b/openapi/ghe-2.17/operations/repos/add-protected-branch-required-signatures.json index d8e94ccf49..92b602cc7b 100644 --- a/openapi/ghe-2.17/operations/repos/add-protected-branch-required-signatures.json +++ b/openapi/ghe-2.17/operations/repos/add-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/add-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.17/operations/repos/add-protected-branch-required-status-checks-contexts.json index 38b6b879b8..27e48dd7a2 100644 --- a/openapi/ghe-2.17/operations/repos/add-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.17/operations/repos/add-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/add-protected-branch-team-restrictions.json b/openapi/ghe-2.17/operations/repos/add-protected-branch-team-restrictions.json index d564f8d32d..e34ed03723 100644 --- a/openapi/ghe-2.17/operations/repos/add-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/add-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/add-protected-branch-user-restrictions.json b/openapi/ghe-2.17/operations/repos/add-protected-branch-user-restrictions.json index 3eedfbf237..3edcc93fe7 100644 --- a/openapi/ghe-2.17/operations/repos/add-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/add-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/check-collaborator.json b/openapi/ghe-2.17/operations/repos/check-collaborator.json index 0c7711be51..cd92e238ba 100644 --- a/openapi/ghe-2.17/operations/repos/check-collaborator.json +++ b/openapi/ghe-2.17/operations/repos/check-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/compare-commits.json b/openapi/ghe-2.17/operations/repos/compare-commits.json index 6148856aab..f9b585ff94 100644 --- a/openapi/ghe-2.17/operations/repos/compare-commits.json +++ b/openapi/ghe-2.17/operations/repos/compare-commits.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "base", + "description": "base parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "base parameter" + } }, { "name": "head", + "description": "head parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "head parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/create-commit-comment.json b/openapi/ghe-2.17/operations/repos/create-commit-comment.json index 9874125d96..5a03f8c84f 100644 --- a/openapi/ghe-2.17/operations/repos/create-commit-comment.json +++ b/openapi/ghe-2.17/operations/repos/create-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { @@ -187,20 +187,20 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment.", - "type": "string" + "type": "string", + "description": "The contents of the comment." }, "path": { - "description": "Relative path of the file to comment on.", - "type": "string" + "type": "string", + "description": "Relative path of the file to comment on." }, "position": { - "description": "Line index in the diff to comment on.", - "type": "integer" + "type": "integer", + "description": "Line index in the diff to comment on." }, "line": { - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "type": "integer" + "type": "integer", + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/repos/create-deployment-status.json b/openapi/ghe-2.17/operations/repos/create-deployment-status.json index 7d438eb7b2..4193830e12 100644 --- a/openapi/ghe-2.17/operations/repos/create-deployment-status.json +++ b/openapi/ghe-2.17/operations/repos/create-deployment-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { @@ -182,8 +182,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.", "enum": [ "error", "failure", @@ -195,23 +195,23 @@ ] }, "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", + "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": "" }, "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", + "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": "" }, "description": { - "description": "A short description of the status. The maximum description length is 140 characters.", "type": "string", + "description": "A short description of the status. The maximum description length is 140 characters.", "default": "" }, "environment": { - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.", "type": "string", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.", "enum": [ "production", "staging", @@ -219,13 +219,13 @@ ] }, "environment_url": { - "description": "Sets the URL for accessing your environment.", "type": "string", + "description": "Sets the URL for accessing your environment.", "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. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type. **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.", "type": "boolean", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type. **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/repos/create-deployment.json b/openapi/ghe-2.17/operations/repos/create-deployment.json index 4aa3ba3711..15827b9c91 100644 --- a/openapi/ghe-2.17/operations/repos/create-deployment.json +++ b/openapi/ghe-2.17/operations/repos/create-deployment.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,49 +66,49 @@ "type": "object", "properties": { "ref": { - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "type": "string" + "type": "string", + "description": "The ref to deploy. This can be a branch, tag, or SHA." }, "task": { - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "type": "string", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "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", + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", "default": true }, "required_contexts": { - "description": "The [status](https://developer.github.com/enterprise/2.17/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", + "description": "The [status](https://developer.github.com/enterprise/2.17/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.", "items": { "type": "string" } }, "payload": { - "description": "JSON payload with extra information about the deployment.", "type": "string", + "description": "JSON payload with extra information about the deployment.", "default": "" }, "environment": { - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "type": "string", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", "default": "production" }, "description": { - "description": "Short description of the deployment.", "type": "string", + "description": "Short description of the deployment.", "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", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.", "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" + "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." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/repos/create-for-authenticated-user.json b/openapi/ghe-2.17/operations/repos/create-for-authenticated-user.json index 1e6b8d013d..49933050e5 100644 --- a/openapi/ghe-2.17/operations/repos/create-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/repos/create-for-authenticated-user.json @@ -358,67 +358,67 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/repos/create-fork.json b/openapi/ghe-2.17/operations/repos/create-fork.json index c7e7c40422..2c4fb00abd 100644 --- a/openapi/ghe-2.17/operations/repos/create-fork.json +++ b/openapi/ghe-2.17/operations/repos/create-fork.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -376,8 +376,8 @@ "type": "object", "properties": { "organization": { - "description": "Optional parameter to specify the organization name if forking into an organization.", - "type": "string" + "type": "string", + "description": "Optional parameter to specify the organization name if forking into an organization." } } } diff --git a/openapi/ghe-2.17/operations/repos/create-hook.json b/openapi/ghe-2.17/operations/repos/create-hook.json index 4d63d8e300..e354be5308 100644 --- a/openapi/ghe-2.17/operations/repos/create-hook.json +++ b/openapi/ghe-2.17/operations/repos/create-hook.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -136,29 +136,29 @@ "type": "object", "properties": { "name": { - "description": "Use `web` to create a webhook.", "type": "string", + "description": "Use `web` to create a webhook.", "default": "web" }, "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.17/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.17/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -166,8 +166,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.", "default": [ "push" ], @@ -176,8 +176,8 @@ } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/repos/create-in-org.json b/openapi/ghe-2.17/operations/repos/create-in-org.json index f8133e65a1..4370a14eef 100644 --- a/openapi/ghe-2.17/operations/repos/create-in-org.json +++ b/openapi/ghe-2.17/operations/repos/create-in-org.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -367,67 +367,67 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "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" + "type": "integer", + "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." }, "auto_init": { - "description": "Pass `true` to create an initial commit with empty README.", "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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\"." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true } }, diff --git a/openapi/ghe-2.17/operations/repos/create-or-update-file.json b/openapi/ghe-2.17/operations/repos/create-or-update-file.json index bbaded207e..eff164b5ae 100644 --- a/openapi/ghe-2.17/operations/repos/create-or-update-file.json +++ b/openapi/ghe-2.17/operations/repos/create-or-update-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -250,32 +250,32 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "content": { - "description": "The new file content, using Base64 encoding.", - "type": "string" + "type": "string", + "description": "The new file content, using Base64 encoding." }, "sha": { - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "The person that committed the file. Default: the authenticated user.", "type": "object", + "description": "The person that committed the file. Default: the authenticated user.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ @@ -284,16 +284,16 @@ ] }, "author": { - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "type": "object", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "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" + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." }, "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" + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/repos/create-release.json b/openapi/ghe-2.17/operations/repos/create-release.json index 68fbdfe2c4..23d7ed694d 100644 --- a/openapi/ghe-2.17/operations/repos/create-release.json +++ b/openapi/ghe-2.17/operations/repos/create-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -187,29 +187,29 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "type": "boolean", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", "default": false }, "prerelease": { - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "type": "boolean", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", "default": false } }, diff --git a/openapi/ghe-2.17/operations/repos/create-status.json b/openapi/ghe-2.17/operations/repos/create-status.json index f9dd19916f..7a995c1800 100644 --- a/openapi/ghe-2.17/operations/repos/create-status.json +++ b/openapi/ghe-2.17/operations/repos/create-status.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "sha parameter" + } } ], "responses": { @@ -173,8 +173,8 @@ "type": "object", "properties": { "state": { - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "type": "string", + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", "enum": [ "error", "failure", @@ -183,16 +183,16 @@ ] }, "target_url": { - "description": "The target URL to associate with this status. This URL will be linked from the GitHub Enterprise Server 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" + "type": "string", + "description": "The target URL to associate with this status. This URL will be linked from the GitHub Enterprise Server 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`" }, "description": { - "description": "A short description of the status.", - "type": "string" + "type": "string", + "description": "A short description of the status." }, "context": { - "description": "A string label to differentiate this status from the status of other systems.", "type": "string", + "description": "A string label to differentiate this status from the status of other systems.", "default": "default" } }, diff --git a/openapi/ghe-2.17/operations/repos/decline-invitation.json b/openapi/ghe-2.17/operations/repos/decline-invitation.json index a8349ec46a..9d439296b5 100644 --- a/openapi/ghe-2.17/operations/repos/decline-invitation.json +++ b/openapi/ghe-2.17/operations/repos/decline-invitation.json @@ -21,12 +21,12 @@ }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete-commit-comment.json b/openapi/ghe-2.17/operations/repos/delete-commit-comment.json index 2228b28bf7..7ceef65d9b 100644 --- a/openapi/ghe-2.17/operations/repos/delete-commit-comment.json +++ b/openapi/ghe-2.17/operations/repos/delete-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete-download.json b/openapi/ghe-2.17/operations/repos/delete-download.json index 952cfa1b70..5405a264f3 100644 --- a/openapi/ghe-2.17/operations/repos/delete-download.json +++ b/openapi/ghe-2.17/operations/repos/delete-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete-file.json b/openapi/ghe-2.17/operations/repos/delete-file.json index 8f0c1c02ad..302979d4f1 100644 --- a/openapi/ghe-2.17/operations/repos/delete-file.json +++ b/openapi/ghe-2.17/operations/repos/delete-file.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } } ], "responses": { @@ -180,42 +180,42 @@ "type": "object", "properties": { "message": { - "description": "The commit message.", - "type": "string" + "type": "string", + "description": "The commit message." }, "sha": { - "description": "The blob SHA of the file being replaced.", - "type": "string" + "type": "string", + "description": "The blob SHA of the file being replaced." }, "branch": { - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "type": "string" + "type": "string", + "description": "The branch name. Default: the repository’s default branch (usually `master`)" }, "committer": { - "description": "object containing information about the committer.", "type": "object", + "description": "object containing information about the committer.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } }, "author": { - "description": "object containing information about the author.", "type": "object", + "description": "object containing information about the author.", "properties": { "name": { - "description": "The name of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The name of the author (or committer) of the commit" }, "email": { - "description": "The email of the author (or committer) of the commit", - "type": "string" + "type": "string", + "description": "The email of the author (or committer) of the commit" } } } diff --git a/openapi/ghe-2.17/operations/repos/delete-hook.json b/openapi/ghe-2.17/operations/repos/delete-hook.json index b0e80b739e..078039caae 100644 --- a/openapi/ghe-2.17/operations/repos/delete-hook.json +++ b/openapi/ghe-2.17/operations/repos/delete-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete-invitation.json b/openapi/ghe-2.17/operations/repos/delete-invitation.json index cfeb196894..b538df9da4 100644 --- a/openapi/ghe-2.17/operations/repos/delete-invitation.json +++ b/openapi/ghe-2.17/operations/repos/delete-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete-release-asset.json b/openapi/ghe-2.17/operations/repos/delete-release-asset.json index ef4c792459..4ebc204622 100644 --- a/openapi/ghe-2.17/operations/repos/delete-release-asset.json +++ b/openapi/ghe-2.17/operations/repos/delete-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete-release.json b/openapi/ghe-2.17/operations/repos/delete-release.json index f91a60a56a..eadb8d80b8 100644 --- a/openapi/ghe-2.17/operations/repos/delete-release.json +++ b/openapi/ghe-2.17/operations/repos/delete-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/delete.json b/openapi/ghe-2.17/operations/repos/delete.json index 2665cd35b5..57b4b2c248 100644 --- a/openapi/ghe-2.17/operations/repos/delete.json +++ b/openapi/ghe-2.17/operations/repos/delete.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/disable-pages-site.json b/openapi/ghe-2.17/operations/repos/disable-pages-site.json index 9f4b825ae8..049d3ca88b 100644 --- a/openapi/ghe-2.17/operations/repos/disable-pages-site.json +++ b/openapi/ghe-2.17/operations/repos/disable-pages-site.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/enable-pages-site.json b/openapi/ghe-2.17/operations/repos/enable-pages-site.json index 073ad02b77..d6e184444b 100644 --- a/openapi/ghe-2.17/operations/repos/enable-pages-site.json +++ b/openapi/ghe-2.17/operations/repos/enable-pages-site.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -102,20 +102,20 @@ "type": "object", "properties": { "source": { - "description": "source parameter", "type": "object", + "description": "source parameter", "properties": { "branch": { - "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", "type": "string", + "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", "enum": [ "master", "gh-pages" ] }, "path": { - "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", - "type": "string" + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`." } } } diff --git a/openapi/ghe-2.17/operations/repos/get-archive-link.json b/openapi/ghe-2.17/operations/repos/get-archive-link.json index df3de84293..8723ca461c 100644 --- a/openapi/ghe-2.17/operations/repos/get-archive-link.json +++ b/openapi/ghe-2.17/operations/repos/get-archive-link.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "archive_format", + "description": "archive_format parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "archive_format parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-branch-protection.json b/openapi/ghe-2.17/operations/repos/get-branch-protection.json index 1f082c14cb..4709b04795 100644 --- a/openapi/ghe-2.17/operations/repos/get-branch-protection.json +++ b/openapi/ghe-2.17/operations/repos/get-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-branch.json b/openapi/ghe-2.17/operations/repos/get-branch.json index 90da58f616..cc0cffe5a7 100644 --- a/openapi/ghe-2.17/operations/repos/get-branch.json +++ b/openapi/ghe-2.17/operations/repos/get-branch.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-code-frequency-stats.json b/openapi/ghe-2.17/operations/repos/get-code-frequency-stats.json index f16521b6b0..b8e919a17b 100644 --- a/openapi/ghe-2.17/operations/repos/get-code-frequency-stats.json +++ b/openapi/ghe-2.17/operations/repos/get-code-frequency-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-collaborator-permission-level.json b/openapi/ghe-2.17/operations/repos/get-collaborator-permission-level.json index e11dc15bae..58e0c05b66 100644 --- a/openapi/ghe-2.17/operations/repos/get-collaborator-permission-level.json +++ b/openapi/ghe-2.17/operations/repos/get-collaborator-permission-level.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-combined-status-for-ref.json b/openapi/ghe-2.17/operations/repos/get-combined-status-for-ref.json index 7bbe12df70..295fdaeaa9 100644 --- a/openapi/ghe-2.17/operations/repos/get-combined-status-for-ref.json +++ b/openapi/ghe-2.17/operations/repos/get-combined-status-for-ref.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-commit-activity-stats.json b/openapi/ghe-2.17/operations/repos/get-commit-activity-stats.json index d296c8a063..17ad46423f 100644 --- a/openapi/ghe-2.17/operations/repos/get-commit-activity-stats.json +++ b/openapi/ghe-2.17/operations/repos/get-commit-activity-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-commit-comment.json b/openapi/ghe-2.17/operations/repos/get-commit-comment.json index 6004da812d..92f2d978e5 100644 --- a/openapi/ghe-2.17/operations/repos/get-commit-comment.json +++ b/openapi/ghe-2.17/operations/repos/get-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-commit.json b/openapi/ghe-2.17/operations/repos/get-commit.json index 983fa2df96..f38ad7ed7c 100644 --- a/openapi/ghe-2.17/operations/repos/get-commit.json +++ b/openapi/ghe-2.17/operations/repos/get-commit.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-contents.json b/openapi/ghe-2.17/operations/repos/get-contents.json index c28239fcfd..df5f19484f 100644 --- a/openapi/ghe-2.17/operations/repos/get-contents.json +++ b/openapi/ghe-2.17/operations/repos/get-contents.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "path", + "description": "path parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "path parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-contributors-stats.json b/openapi/ghe-2.17/operations/repos/get-contributors-stats.json index dd8466f8d7..a8b4beddde 100644 --- a/openapi/ghe-2.17/operations/repos/get-contributors-stats.json +++ b/openapi/ghe-2.17/operations/repos/get-contributors-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-deploy-key.json b/openapi/ghe-2.17/operations/repos/get-deploy-key.json index 111cecd567..22e6e7f696 100644 --- a/openapi/ghe-2.17/operations/repos/get-deploy-key.json +++ b/openapi/ghe-2.17/operations/repos/get-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-deployment-status.json b/openapi/ghe-2.17/operations/repos/get-deployment-status.json index e4c75d196a..e90a3f7ec4 100644 --- a/openapi/ghe-2.17/operations/repos/get-deployment-status.json +++ b/openapi/ghe-2.17/operations/repos/get-deployment-status.json @@ -21,39 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "status_id", + "description": "status_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "status_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-deployment.json b/openapi/ghe-2.17/operations/repos/get-deployment.json index 99ebf712ae..1fcbba2d2a 100644 --- a/openapi/ghe-2.17/operations/repos/get-deployment.json +++ b/openapi/ghe-2.17/operations/repos/get-deployment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-download.json b/openapi/ghe-2.17/operations/repos/get-download.json index d72ef61a1e..f77b161f80 100644 --- a/openapi/ghe-2.17/operations/repos/get-download.json +++ b/openapi/ghe-2.17/operations/repos/get-download.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "download_id", + "description": "download_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "download_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-hook.json b/openapi/ghe-2.17/operations/repos/get-hook.json index 6f1816febb..bc5f15e84b 100644 --- a/openapi/ghe-2.17/operations/repos/get-hook.json +++ b/openapi/ghe-2.17/operations/repos/get-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-latest-pages-build.json b/openapi/ghe-2.17/operations/repos/get-latest-pages-build.json index 47d0d17cb8..9530b550fd 100644 --- a/openapi/ghe-2.17/operations/repos/get-latest-pages-build.json +++ b/openapi/ghe-2.17/operations/repos/get-latest-pages-build.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-latest-release.json b/openapi/ghe-2.17/operations/repos/get-latest-release.json index ef1c828a52..31869062d6 100644 --- a/openapi/ghe-2.17/operations/repos/get-latest-release.json +++ b/openapi/ghe-2.17/operations/repos/get-latest-release.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-pages-build.json b/openapi/ghe-2.17/operations/repos/get-pages-build.json index 0c7226b97f..e8a16dcc3d 100644 --- a/openapi/ghe-2.17/operations/repos/get-pages-build.json +++ b/openapi/ghe-2.17/operations/repos/get-pages-build.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "build_id", + "description": "build_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "build_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-pages.json b/openapi/ghe-2.17/operations/repos/get-pages.json index e5743264f0..4f3740d8e1 100644 --- a/openapi/ghe-2.17/operations/repos/get-pages.json +++ b/openapi/ghe-2.17/operations/repos/get-pages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-participation-stats.json b/openapi/ghe-2.17/operations/repos/get-participation-stats.json index b7d118db9e..3f013c56cc 100644 --- a/openapi/ghe-2.17/operations/repos/get-participation-stats.json +++ b/openapi/ghe-2.17/operations/repos/get-participation-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-protected-branch-admin-enforcement.json b/openapi/ghe-2.17/operations/repos/get-protected-branch-admin-enforcement.json index 8b2e8d07a4..8bc4557005 100644 --- a/openapi/ghe-2.17/operations/repos/get-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.17/operations/repos/get-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.17/operations/repos/get-protected-branch-pull-request-review-enforcement.json index 86030c5366..136f8ec77e 100644 --- a/openapi/ghe-2.17/operations/repos/get-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.17/operations/repos/get-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-protected-branch-required-signatures.json b/openapi/ghe-2.17/operations/repos/get-protected-branch-required-signatures.json index 57a38f07a9..1aefd63dbd 100644 --- a/openapi/ghe-2.17/operations/repos/get-protected-branch-required-signatures.json +++ b/openapi/ghe-2.17/operations/repos/get-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-protected-branch-required-status-checks.json b/openapi/ghe-2.17/operations/repos/get-protected-branch-required-status-checks.json index ef60fa7901..53e0e20943 100644 --- a/openapi/ghe-2.17/operations/repos/get-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.17/operations/repos/get-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-protected-branch-restrictions.json b/openapi/ghe-2.17/operations/repos/get-protected-branch-restrictions.json index 576a708b53..1120b1047d 100644 --- a/openapi/ghe-2.17/operations/repos/get-protected-branch-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/get-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-punch-card-stats.json b/openapi/ghe-2.17/operations/repos/get-punch-card-stats.json index 89004ab035..a9b6ba6993 100644 --- a/openapi/ghe-2.17/operations/repos/get-punch-card-stats.json +++ b/openapi/ghe-2.17/operations/repos/get-punch-card-stats.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-readme.json b/openapi/ghe-2.17/operations/repos/get-readme.json index bf1de239f2..f47d7cc39a 100644 --- a/openapi/ghe-2.17/operations/repos/get-readme.json +++ b/openapi/ghe-2.17/operations/repos/get-readme.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-release-asset.json b/openapi/ghe-2.17/operations/repos/get-release-asset.json index 4546fef676..33c52dfbcc 100644 --- a/openapi/ghe-2.17/operations/repos/get-release-asset.json +++ b/openapi/ghe-2.17/operations/repos/get-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-release-by-tag.json b/openapi/ghe-2.17/operations/repos/get-release-by-tag.json index 013eae20cf..9ac74f9934 100644 --- a/openapi/ghe-2.17/operations/repos/get-release-by-tag.json +++ b/openapi/ghe-2.17/operations/repos/get-release-by-tag.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tag", + "description": "tag parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "tag parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get-release.json b/openapi/ghe-2.17/operations/repos/get-release.json index 39e967504e..b1623fb9ed 100644 --- a/openapi/ghe-2.17/operations/repos/get-release.json +++ b/openapi/ghe-2.17/operations/repos/get-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/get.json b/openapi/ghe-2.17/operations/repos/get.json index 6cfdc897e7..4566bf131c 100644 --- a/openapi/ghe-2.17/operations/repos/get.json +++ b/openapi/ghe-2.17/operations/repos/get.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-assets-for-release.json b/openapi/ghe-2.17/operations/repos/list-assets-for-release.json index 38528b3284..6444697cac 100644 --- a/openapi/ghe-2.17/operations/repos/list-assets-for-release.json +++ b/openapi/ghe-2.17/operations/repos/list-assets-for-release.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-branches-for-head-commit.json b/openapi/ghe-2.17/operations/repos/list-branches-for-head-commit.json index f50951a108..15d7f27c45 100644 --- a/openapi/ghe-2.17/operations/repos/list-branches-for-head-commit.json +++ b/openapi/ghe-2.17/operations/repos/list-branches-for-head-commit.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-branches.json b/openapi/ghe-2.17/operations/repos/list-branches.json index 10411a185d..07700f6627 100644 --- a/openapi/ghe-2.17/operations/repos/list-branches.json +++ b/openapi/ghe-2.17/operations/repos/list-branches.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "protected", + "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", + "required": false, "schema": { "type": "boolean" - }, - "required": false, - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-collaborators.json b/openapi/ghe-2.17/operations/repos/list-collaborators.json index b421621eda..03b58c875f 100644 --- a/openapi/ghe-2.17/operations/repos/list-collaborators.json +++ b/openapi/ghe-2.17/operations/repos/list-collaborators.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-comments-for-commit.json b/openapi/ghe-2.17/operations/repos/list-comments-for-commit.json index 093d9cf158..5b761cd8aa 100644 --- a/openapi/ghe-2.17/operations/repos/list-comments-for-commit.json +++ b/openapi/ghe-2.17/operations/repos/list-comments-for-commit.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-commit-comments.json b/openapi/ghe-2.17/operations/repos/list-commit-comments.json index f274be8bb5..9a3ea3df29 100644 --- a/openapi/ghe-2.17/operations/repos/list-commit-comments.json +++ b/openapi/ghe-2.17/operations/repos/list-commit-comments.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-commits.json b/openapi/ghe-2.17/operations/repos/list-commits.json index 1866124bec..c936d92dd9 100644 --- a/openapi/ghe-2.17/operations/repos/list-commits.json +++ b/openapi/ghe-2.17/operations/repos/list-commits.json @@ -21,86 +21,84 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`)." + } }, { "name": "path", + "description": "Only commits containing this file path will be returned.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Only commits containing this file path will be returned." + } }, { "name": "author", + "description": "GitHub login or email address by which to filter by commit author.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "GitHub login or email address by which to filter by commit author." + } }, { "name": "since", + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-contributors.json b/openapi/ghe-2.17/operations/repos/list-contributors.json index 32633d6514..ec1723fa0b 100644 --- a/openapi/ghe-2.17/operations/repos/list-contributors.json +++ b/openapi/ghe-2.17/operations/repos/list-contributors.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Set to `1` or `true` to include anonymous contributors in results." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-deploy-keys.json b/openapi/ghe-2.17/operations/repos/list-deploy-keys.json index 2c854c5ff3..7ecdf1937a 100644 --- a/openapi/ghe-2.17/operations/repos/list-deploy-keys.json +++ b/openapi/ghe-2.17/operations/repos/list-deploy-keys.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-deployment-statuses.json b/openapi/ghe-2.17/operations/repos/list-deployment-statuses.json index 1dd3129bdd..04b811268f 100644 --- a/openapi/ghe-2.17/operations/repos/list-deployment-statuses.json +++ b/openapi/ghe-2.17/operations/repos/list-deployment-statuses.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "deployment_id", + "description": "deployment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "deployment_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-deployments.json b/openapi/ghe-2.17/operations/repos/list-deployments.json index 7f7f52261a..f7aad0be4d 100644 --- a/openapi/ghe-2.17/operations/repos/list-deployments.json +++ b/openapi/ghe-2.17/operations/repos/list-deployments.json @@ -21,81 +21,79 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sha", + "description": "The SHA recorded at creation time.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The SHA recorded at creation time." + } }, { "name": "ref", + "description": "The name of the ref. This can be a branch, tag, or SHA.", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the ref. This can be a branch, tag, or SHA." + } }, { "name": "task", + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", "in": "query", + "required": false, "schema": { "type": "string", "default": "none" - }, - "required": false, - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`)." + } }, { "name": "environment", + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-downloads.json b/openapi/ghe-2.17/operations/repos/list-downloads.json index 85358e65d3..9631e6ef8b 100644 --- a/openapi/ghe-2.17/operations/repos/list-downloads.json +++ b/openapi/ghe-2.17/operations/repos/list-downloads.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-for-org.json b/openapi/ghe-2.17/operations/repos/list-for-org.json index 3dfb56d91f..c4e7cafbd9 100644 --- a/openapi/ghe-2.17/operations/repos/list-for-org.json +++ b/openapi/ghe-2.17/operations/repos/list-for-org.json @@ -21,16 +21,18 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -42,13 +44,13 @@ "member" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`." + } }, { "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -58,42 +60,38 @@ "full_name" ], "default": "created" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-for-user.json b/openapi/ghe-2.17/operations/repos/list-for-user.json index fd0140088c..f1986bfbc6 100644 --- a/openapi/ghe-2.17/operations/repos/list-for-user.json +++ b/openapi/ghe-2.17/operations/repos/list-for-user.json @@ -21,16 +21,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "type", + "description": "Can be one of `all`, `owner`, `member`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "member" ], "default": "owner" - }, - "required": false, - "description": "Can be one of `all`, `owner`, `member`." + } }, { "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -55,42 +57,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-forks.json b/openapi/ghe-2.17/operations/repos/list-forks.json index f570f575dc..0237cd4477 100644 --- a/openapi/ghe-2.17/operations/repos/list-forks.json +++ b/openapi/ghe-2.17/operations/repos/list-forks.json @@ -21,25 +21,27 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "sort", + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "stargazers" ], "default": "newest" - }, - "required": false, - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-hooks.json b/openapi/ghe-2.17/operations/repos/list-hooks.json index 9b48e60600..d2cd04ed67 100644 --- a/openapi/ghe-2.17/operations/repos/list-hooks.json +++ b/openapi/ghe-2.17/operations/repos/list-hooks.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-invitations-for-authenticated-user.json b/openapi/ghe-2.17/operations/repos/list-invitations-for-authenticated-user.json index 4a5859036d..9b7ddf1474 100644 --- a/openapi/ghe-2.17/operations/repos/list-invitations-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/repos/list-invitations-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-invitations.json b/openapi/ghe-2.17/operations/repos/list-invitations.json index 2556ec13ee..fa1f4f9cfe 100644 --- a/openapi/ghe-2.17/operations/repos/list-invitations.json +++ b/openapi/ghe-2.17/operations/repos/list-invitations.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-languages.json b/openapi/ghe-2.17/operations/repos/list-languages.json index 4b801017cd..73a6351619 100644 --- a/openapi/ghe-2.17/operations/repos/list-languages.json +++ b/openapi/ghe-2.17/operations/repos/list-languages.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-pages-builds.json b/openapi/ghe-2.17/operations/repos/list-pages-builds.json index c9e0c45aaa..4149410ae1 100644 --- a/openapi/ghe-2.17/operations/repos/list-pages-builds.json +++ b/openapi/ghe-2.17/operations/repos/list-pages-builds.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.17/operations/repos/list-protected-branch-required-status-checks-contexts.json index cdebb141d8..68fd9bae64 100644 --- a/openapi/ghe-2.17/operations/repos/list-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.17/operations/repos/list-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-protected-branch-team-restrictions.json b/openapi/ghe-2.17/operations/repos/list-protected-branch-team-restrictions.json index ff0b92a4e6..026d5fbc5c 100644 --- a/openapi/ghe-2.17/operations/repos/list-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/list-protected-branch-team-restrictions.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-protected-branch-user-restrictions.json b/openapi/ghe-2.17/operations/repos/list-protected-branch-user-restrictions.json index 1b5051013d..454bcd6549 100644 --- a/openapi/ghe-2.17/operations/repos/list-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/list-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-public.json b/openapi/ghe-2.17/operations/repos/list-public.json index 20dfb70f63..6f1198ec6e 100644 --- a/openapi/ghe-2.17/operations/repos/list-public.json +++ b/openapi/ghe-2.17/operations/repos/list-public.json @@ -21,42 +21,40 @@ }, { "name": "since", + "description": "The integer ID of the last Repository that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last Repository that you've seen." + } }, { "name": "visibility", + "description": "To include private repositories as well set to `all`.", "in": "query", + "required": false, "schema": { "type": "string", "default": "public" - }, - "required": false, - "description": "To include private repositories as well set to `all`." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-pull-requests-associated-with-commit.json b/openapi/ghe-2.17/operations/repos/list-pull-requests-associated-with-commit.json index 88b2b43401..973a116933 100644 --- a/openapi/ghe-2.17/operations/repos/list-pull-requests-associated-with-commit.json +++ b/openapi/ghe-2.17/operations/repos/list-pull-requests-associated-with-commit.json @@ -22,50 +22,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "commit_sha", + "description": "commit_sha parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "commit_sha parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-releases.json b/openapi/ghe-2.17/operations/repos/list-releases.json index c1d77461af..7b214375d4 100644 --- a/openapi/ghe-2.17/operations/repos/list-releases.json +++ b/openapi/ghe-2.17/operations/repos/list-releases.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-statuses-for-ref.json b/openapi/ghe-2.17/operations/repos/list-statuses-for-ref.json index 5f189522cd..1e2b67f36d 100644 --- a/openapi/ghe-2.17/operations/repos/list-statuses-for-ref.json +++ b/openapi/ghe-2.17/operations/repos/list-statuses-for-ref.json @@ -21,50 +21,48 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "ref parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "ref parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-tags.json b/openapi/ghe-2.17/operations/repos/list-tags.json index 55aafef0a3..720b8ba6ae 100644 --- a/openapi/ghe-2.17/operations/repos/list-tags.json +++ b/openapi/ghe-2.17/operations/repos/list-tags.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-teams.json b/openapi/ghe-2.17/operations/repos/list-teams.json index 88979458b4..0fbf59946d 100644 --- a/openapi/ghe-2.17/operations/repos/list-teams.json +++ b/openapi/ghe-2.17/operations/repos/list-teams.json @@ -21,41 +21,39 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list-topics.json b/openapi/ghe-2.17/operations/repos/list-topics.json index 6ff0a79448..9e05800077 100644 --- a/openapi/ghe-2.17/operations/repos/list-topics.json +++ b/openapi/ghe-2.17/operations/repos/list-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/list.json b/openapi/ghe-2.17/operations/repos/list.json index 1f84b5f712..53a2487722 100644 --- a/openapi/ghe-2.17/operations/repos/list.json +++ b/openapi/ghe-2.17/operations/repos/list.json @@ -21,7 +21,9 @@ }, { "name": "visibility", + "description": "Can be one of `all`, `public`, or `private`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -30,23 +32,23 @@ "private" ], "default": "all" - }, - "required": false, - "description": "Can be one of `all`, `public`, or `private`." + } }, { "name": "affiliation", + "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.", "in": "query", + "required": false, "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", + "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**.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -57,13 +59,13 @@ "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", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -73,42 +75,38 @@ "full_name" ], "default": "full_name" - }, - "required": false, - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + } }, { "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "in": "query", + "required": false, "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/merge.json b/openapi/ghe-2.17/operations/repos/merge.json index 14856cb250..f8966ceeae 100644 --- a/openapi/ghe-2.17/operations/repos/merge.json +++ b/openapi/ghe-2.17/operations/repos/merge.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,16 +66,16 @@ "type": "object", "properties": { "base": { - "description": "The name of the base branch that the head will be merged into.", - "type": "string" + "type": "string", + "description": "The name of the base branch that the head will be merged into." }, "head": { - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "type": "string" + "type": "string", + "description": "The head to merge. This can be a branch name or a commit SHA1." }, "commit_message": { - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "type": "string" + "type": "string", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/repos/ping-hook.json b/openapi/ghe-2.17/operations/repos/ping-hook.json index 8fd5c03e4a..1f066c7bfb 100644 --- a/openapi/ghe-2.17/operations/repos/ping-hook.json +++ b/openapi/ghe-2.17/operations/repos/ping-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-branch-protection.json b/openapi/ghe-2.17/operations/repos/remove-branch-protection.json index 03e81675c3..f8610dc60a 100644 --- a/openapi/ghe-2.17/operations/repos/remove-branch-protection.json +++ b/openapi/ghe-2.17/operations/repos/remove-branch-protection.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-collaborator.json b/openapi/ghe-2.17/operations/repos/remove-collaborator.json index f2b433c972..f2bb84c272 100644 --- a/openapi/ghe-2.17/operations/repos/remove-collaborator.json +++ b/openapi/ghe-2.17/operations/repos/remove-collaborator.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-deploy-key.json b/openapi/ghe-2.17/operations/repos/remove-deploy-key.json index 843b92898b..b1bf8f9eb3 100644 --- a/openapi/ghe-2.17/operations/repos/remove-deploy-key.json +++ b/openapi/ghe-2.17/operations/repos/remove-deploy-key.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-admin-enforcement.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-admin-enforcement.json index 50d9bd7e14..0c7ec76ac6 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-admin-enforcement.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-admin-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-pull-request-review-enforcement.json index 09570aadab..0270716af4 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-pull-request-review-enforcement.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-signatures.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-signatures.json index c4daea0567..2660428883 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-signatures.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-signatures.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks-contexts.json index 408ac251c2..0d4121863c 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks.json index c7dc70a236..cdd8d83dbc 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-restrictions.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-restrictions.json index c3b4bb14b7..0eec163d3f 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-team-restrictions.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-team-restrictions.json index 2120c50b85..52b1bc695f 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/remove-protected-branch-user-restrictions.json b/openapi/ghe-2.17/operations/repos/remove-protected-branch-user-restrictions.json index 871e13dcb6..4cd1a3a9fc 100644 --- a/openapi/ghe-2.17/operations/repos/remove-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/remove-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/replace-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.17/operations/repos/replace-protected-branch-required-status-checks-contexts.json index afaeb3693c..aa6629c3c7 100644 --- a/openapi/ghe-2.17/operations/repos/replace-protected-branch-required-status-checks-contexts.json +++ b/openapi/ghe-2.17/operations/repos/replace-protected-branch-required-status-checks-contexts.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -84,10 +84,10 @@ "application/json": { "schema": { "type": "array", + "description": "contexts parameter", "items": { "type": "string" - }, - "description": "contexts parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/replace-protected-branch-team-restrictions.json b/openapi/ghe-2.17/operations/repos/replace-protected-branch-team-restrictions.json index cca58e5473..5d4408f82e 100644 --- a/openapi/ghe-2.17/operations/repos/replace-protected-branch-team-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/replace-protected-branch-team-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -119,10 +119,10 @@ "application/json": { "schema": { "type": "array", + "description": "teams parameter", "items": { "type": "string" - }, - "description": "teams parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/replace-protected-branch-user-restrictions.json b/openapi/ghe-2.17/operations/repos/replace-protected-branch-user-restrictions.json index 4f309da2d3..be047996d1 100644 --- a/openapi/ghe-2.17/operations/repos/replace-protected-branch-user-restrictions.json +++ b/openapi/ghe-2.17/operations/repos/replace-protected-branch-user-restrictions.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -140,10 +140,10 @@ "application/json": { "schema": { "type": "array", + "description": "users parameter", "items": { "type": "string" - }, - "description": "users parameter" + } } } } diff --git a/openapi/ghe-2.17/operations/repos/replace-topics.json b/openapi/ghe-2.17/operations/repos/replace-topics.json index 06abc0063c..3b2403c3b7 100644 --- a/openapi/ghe-2.17/operations/repos/replace-topics.json +++ b/openapi/ghe-2.17/operations/repos/replace-topics.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -81,8 +81,8 @@ "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", + "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.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/repos/request-page-build.json b/openapi/ghe-2.17/operations/repos/request-page-build.json index a1af734b4b..18db777422 100644 --- a/openapi/ghe-2.17/operations/repos/request-page-build.json +++ b/openapi/ghe-2.17/operations/repos/request-page-build.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/test-push-hook.json b/openapi/ghe-2.17/operations/repos/test-push-hook.json index dec4d15182..f8b190672c 100644 --- a/openapi/ghe-2.17/operations/repos/test-push-hook.json +++ b/openapi/ghe-2.17/operations/repos/test-push-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/repos/transfer.json b/openapi/ghe-2.17/operations/repos/transfer.json index 00a5ebeb9e..e31f8eeaec 100644 --- a/openapi/ghe-2.17/operations/repos/transfer.json +++ b/openapi/ghe-2.17/operations/repos/transfer.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -377,12 +377,12 @@ "type": "object", "properties": { "new_owner": { - "description": "**Required:** The username or organization name the repository will be transferred to.", - "type": "string" + "type": "string", + "description": "**Required:** The username or organization name the repository will be transferred to." }, "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", + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", "items": { "type": "integer" } diff --git a/openapi/ghe-2.17/operations/repos/update-branch-protection.json b/openapi/ghe-2.17/operations/repos/update-branch-protection.json index 052b97237c..d3e4ca9c65 100644 --- a/openapi/ghe-2.17/operations/repos/update-branch-protection.json +++ b/openapi/ghe-2.17/operations/repos/update-branch-protection.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -370,17 +370,17 @@ "type": "object", "properties": { "required_status_checks": { - "description": "Require status checks to pass before merging. Set to `null` to disable.", "type": "object", + "description": "Require status checks to pass before merging. Set to `null` to disable.", "nullable": true, "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } @@ -392,29 +392,29 @@ ] }, "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", + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", "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", + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -422,34 +422,34 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them." }, "required_approving_review_count": { - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } }, "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", + "description": "Restrict who can push to this branch. Team and user `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", "nullable": true, "properties": { "users": { - "description": "The list of user `login`s with push access", "type": "array", + "description": "The list of user `login`s with push access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with push access", "type": "array", + "description": "The list of team `slug`s with push access", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/repos/update-commit-comment.json b/openapi/ghe-2.17/operations/repos/update-commit-comment.json index d575a8b775..2eedad7c2c 100644 --- a/openapi/ghe-2.17/operations/repos/update-commit-comment.json +++ b/openapi/ghe-2.17/operations/repos/update-commit-comment.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "comment_id", + "description": "comment_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_id parameter" + } } ], "responses": { @@ -176,8 +176,8 @@ "type": "object", "properties": { "body": { - "description": "The contents of the comment", - "type": "string" + "type": "string", + "description": "The contents of the comment" } }, "required": [ diff --git a/openapi/ghe-2.17/operations/repos/update-hook.json b/openapi/ghe-2.17/operations/repos/update-hook.json index c4780e5de7..d398136fc3 100644 --- a/openapi/ghe-2.17/operations/repos/update-hook.json +++ b/openapi/ghe-2.17/operations/repos/update-hook.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "hook_id", + "description": "hook_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "hook_id parameter" + } } ], "responses": { @@ -145,24 +145,24 @@ "type": "object", "properties": { "config": { - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-hook-config-params).", "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-hook-config-params).", "properties": { "url": { - "description": "The URL to which the payloads will be delivered.", - "type": "string" + "type": "string", + "description": "The URL to which the payloads will be delivered." }, "content_type": { - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "type": "string" + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`." }, "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.17/webhooks/#delivery-headers) header.", - "type": "string" + "type": "string", + "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.17/webhooks/#delivery-headers) header." }, "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" + "type": "string", + "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.**" } }, "required": [ @@ -170,8 +170,8 @@ ] }, "events": { - "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "type": "array", + "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -180,22 +180,22 @@ } }, "add_events": { - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", "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", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", "items": { "type": "string" } }, "active": { - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", "default": true } } diff --git a/openapi/ghe-2.17/operations/repos/update-information-about-pages-site.json b/openapi/ghe-2.17/operations/repos/update-information-about-pages-site.json index 7da0302c56..c3358a8fd9 100644 --- a/openapi/ghe-2.17/operations/repos/update-information-about-pages-site.json +++ b/openapi/ghe-2.17/operations/repos/update-information-about-pages-site.json @@ -21,21 +21,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "type": "object", "properties": { "source": { - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "type": "string", + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", "enum": [ "\"gh-pages\"", "\"master\"", diff --git a/openapi/ghe-2.17/operations/repos/update-invitation.json b/openapi/ghe-2.17/operations/repos/update-invitation.json index 27f8ed4c1b..524fdeba1e 100644 --- a/openapi/ghe-2.17/operations/repos/update-invitation.json +++ b/openapi/ghe-2.17/operations/repos/update-invitation.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "invitation_id", + "description": "invitation_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "invitation_id parameter" + } } ], "responses": { @@ -419,8 +419,8 @@ "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", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.17/operations/repos/update-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.17/operations/repos/update-protected-branch-pull-request-review-enforcement.json index c10981f402..4997206a69 100644 --- a/openapi/ghe-2.17/operations/repos/update-protected-branch-pull-request-review-enforcement.json +++ b/openapi/ghe-2.17/operations/repos/update-protected-branch-pull-request-review-enforcement.json @@ -22,30 +22,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -214,19 +214,19 @@ "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", + "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.", "properties": { "users": { - "description": "The list of user `login`s with dismissal access", "type": "array", + "description": "The list of user `login`s with dismissal access", "items": { "type": "string" } }, "teams": { - "description": "The list of team `slug`s with dismissal access", "type": "array", + "description": "The list of team `slug`s with dismissal access", "items": { "type": "string" } @@ -234,16 +234,16 @@ } }, "dismiss_stale_reviews": { - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "type": "boolean" + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." }, "require_code_owner_reviews": { - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "type": "boolean" + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "type": "integer" + "type": "integer", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6." } } } diff --git a/openapi/ghe-2.17/operations/repos/update-protected-branch-required-status-checks.json b/openapi/ghe-2.17/operations/repos/update-protected-branch-required-status-checks.json index d8a5060d79..6f0372553c 100644 --- a/openapi/ghe-2.17/operations/repos/update-protected-branch-required-status-checks.json +++ b/openapi/ghe-2.17/operations/repos/update-protected-branch-required-status-checks.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "branch", + "description": "branch parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "branch parameter" + } } ], "responses": { @@ -99,12 +99,12 @@ "type": "object", "properties": { "strict": { - "description": "Require branches to be up to date before merging.", - "type": "boolean" + "type": "boolean", + "description": "Require branches to be up to date before merging." }, "contexts": { - "description": "The list of status checks to require in order to merge into this branch", "type": "array", + "description": "The list of status checks to require in order to merge into this branch", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/repos/update-release-asset.json b/openapi/ghe-2.17/operations/repos/update-release-asset.json index 41609add85..3e99039abf 100644 --- a/openapi/ghe-2.17/operations/repos/update-release-asset.json +++ b/openapi/ghe-2.17/operations/repos/update-release-asset.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "asset_id", + "description": "asset_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "asset_id parameter" + } } ], "responses": { @@ -179,12 +179,12 @@ "type": "object", "properties": { "name": { - "description": "The file name of the asset.", - "type": "string" + "type": "string", + "description": "The file name of the asset." }, "label": { - "description": "An alternate short description of the asset. Used in place of the filename.", - "type": "string" + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename." } } } diff --git a/openapi/ghe-2.17/operations/repos/update-release.json b/openapi/ghe-2.17/operations/repos/update-release.json index a3f2425bf2..c3abf8b2bf 100644 --- a/openapi/ghe-2.17/operations/repos/update-release.json +++ b/openapi/ghe-2.17/operations/repos/update-release.json @@ -21,30 +21,30 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "release_id", + "description": "release_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "release_id parameter" + } } ], "responses": { @@ -294,28 +294,28 @@ "type": "object", "properties": { "tag_name": { - "description": "The name of the tag.", - "type": "string" + "type": "string", + "description": "The name of the tag." }, "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" + "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`)." }, "name": { - "description": "The name of the release.", - "type": "string" + "type": "string", + "description": "The name of the release." }, "body": { - "description": "Text describing the contents of the tag.", - "type": "string" + "type": "string", + "description": "Text describing the contents of the tag." }, "draft": { - "description": "`true` makes the release a draft, and `false` publishes the release.", - "type": "boolean" + "type": "boolean", + "description": "`true` makes the release a draft, and `false` publishes the release." }, "prerelease": { - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "type": "boolean" + "type": "boolean", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release." } } } diff --git a/openapi/ghe-2.17/operations/repos/update.json b/openapi/ghe-2.17/operations/repos/update.json index a062897c17..2426d26e87 100644 --- a/openapi/ghe-2.17/operations/repos/update.json +++ b/openapi/ghe-2.17/operations/repos/update.json @@ -22,21 +22,21 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -1045,64 +1045,64 @@ "type": "object", "properties": { "name": { - "description": "The name of the repository.", - "type": "string" + "type": "string", + "description": "The name of the repository." }, "description": { - "description": "A short description of the repository.", - "type": "string" + "type": "string", + "description": "A short description of the repository." }, "homepage": { - "description": "A URL with more information about the repository.", - "type": "string" + "type": "string", + "description": "A URL with more information about the repository." }, "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", + "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.", "default": false }, "has_issues": { - "description": "Either `true` to enable issues for this repository or `false` to disable them.", "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "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", + "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.", "default": true }, "has_wiki": { - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "default": true }, "default_branch": { - "description": "Updates the default branch for this repository.", - "type": "string" + "type": "string", + "description": "Updates the default branch for this repository." }, "allow_squash_merge": { - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "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", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "default": true }, "allow_rebase_merge": { - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "default": true }, "archived": { - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "type": "boolean", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", "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 Server instances that have private mode enabled.", "type": "boolean", + "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 Server instances that have private mode enabled.", "default": false } } diff --git a/openapi/ghe-2.17/operations/search/code.json b/openapi/ghe-2.17/operations/search/code.json index bf74e73b2e..9476b5deb0 100644 --- a/openapi/ghe-2.17/operations/search/code.json +++ b/openapi/ghe-2.17/operations/search/code.json @@ -21,28 +21,30 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.17/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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 Server search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -50,29 +52,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/commits.json b/openapi/ghe-2.17/operations/search/commits.json index 7cca49d8dd..3c36d4f2bb 100644 --- a/openapi/ghe-2.17/operations/search/commits.json +++ b/openapi/ghe-2.17/operations/search/commits.json @@ -22,29 +22,31 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.17/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.17/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/email-legacy.json b/openapi/ghe-2.17/operations/search/email-legacy.json index 7c0b853141..60529db771 100644 --- a/openapi/ghe-2.17/operations/search/email-legacy.json +++ b/openapi/ghe-2.17/operations/search/email-legacy.json @@ -21,12 +21,12 @@ }, { "name": "email", + "description": "The email address.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The email address." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/issues-and-pull-requests.json b/openapi/ghe-2.17/operations/search/issues-and-pull-requests.json index 15c5d41b1e..01ef805b91 100644 --- a/openapi/ghe-2.17/operations/search/issues-and-pull-requests.json +++ b/openapi/ghe-2.17/operations/search/issues-and-pull-requests.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.17/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", + "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.17/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -46,13 +48,13 @@ "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.17/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,29 +62,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/issues-legacy.json b/openapi/ghe-2.17/operations/search/issues-legacy.json index b56e30df9a..884de853ae 100644 --- a/openapi/ghe-2.17/operations/search/issues-legacy.json +++ b/openapi/ghe-2.17/operations/search/issues-legacy.json @@ -21,43 +21,43 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repository", + "description": "repository parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repository parameter" + } }, { "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", "in": "path", + "required": true, "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", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/labels.json b/openapi/ghe-2.17/operations/search/labels.json index ac1406ec45..6c5ef800ec 100644 --- a/openapi/ghe-2.17/operations/search/labels.json +++ b/openapi/ghe-2.17/operations/search/labels.json @@ -21,38 +21,40 @@ }, { "name": "repository_id", + "description": "The id of the repository.", "in": "query", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "The id of the repository." + } }, { "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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.17/v3/search/#constructing-a-search-query)." + } }, { "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)", "in": "query", + "required": false, "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.17/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -60,9 +62,7 @@ "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": { diff --git a/openapi/ghe-2.17/operations/search/repos-legacy.json b/openapi/ghe-2.17/operations/search/repos-legacy.json index 4c4f226df1..a2391a8c88 100644 --- a/openapi/ghe-2.17/operations/search/repos-legacy.json +++ b/openapi/ghe-2.17/operations/search/repos-legacy.json @@ -21,34 +21,36 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "language", + "description": "Filter results by language.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Filter results by language." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -56,22 +58,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/repos.json b/openapi/ghe-2.17/operations/search/repos.json index 85bef457ec..204dd2a1a5 100644 --- a/openapi/ghe-2.17/operations/search/repos.json +++ b/openapi/ghe-2.17/operations/search/repos.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.17/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", + "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.17/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,13 +41,13 @@ "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.17/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -53,29 +55,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/topics.json b/openapi/ghe-2.17/operations/search/topics.json index 5807f9f7c8..b3c5d96e0f 100644 --- a/openapi/ghe-2.17/operations/search/topics.json +++ b/openapi/ghe-2.17/operations/search/topics.json @@ -21,12 +21,12 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query).", "in": "query", + "required": true, "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.17/v3/search/#constructing-a-search-query)." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/users-legacy.json b/openapi/ghe-2.17/operations/search/users-legacy.json index d05db1d6c8..ee76b52fcc 100644 --- a/openapi/ghe-2.17/operations/search/users-legacy.json +++ b/openapi/ghe-2.17/operations/search/users-legacy.json @@ -21,25 +21,27 @@ }, { "name": "keyword", + "description": "The search term.", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The search term." + } }, { "name": "start_page", + "description": "The page number to fetch.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The page number to fetch." + } }, { "name": "sort", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -47,22 +49,20 @@ "forks", "updated" ] - }, - "required": false, - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + } }, { "name": "order", + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] - }, - "required": false, - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/search/users.json b/openapi/ghe-2.17/operations/search/users.json index d5c7a3f8e1..b57484b9a9 100644 --- a/openapi/ghe-2.17/operations/search/users.json +++ b/openapi/ghe-2.17/operations/search/users.json @@ -21,16 +21,18 @@ }, { "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", "in": "query", + "required": true, "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.17/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers." + } }, { "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -38,13 +40,13 @@ "repositories", "joined" ] - }, - "required": false, - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)" + } }, { "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -52,29 +54,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/add-member.json b/openapi/ghe-2.17/operations/teams/add-member.json index c07eb37fd8..00c6110189 100644 --- a/openapi/ghe-2.17/operations/teams/add-member.json +++ b/openapi/ghe-2.17/operations/teams/add-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/add-or-update-membership.json b/openapi/ghe-2.17/operations/teams/add-or-update-membership.json index 4a7b6a33ae..90f9fdc776 100644 --- a/openapi/ghe-2.17/operations/teams/add-or-update-membership.json +++ b/openapi/ghe-2.17/operations/teams/add-or-update-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { @@ -66,8 +66,8 @@ "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", + "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.", "enum": [ "member", "maintainer" diff --git a/openapi/ghe-2.17/operations/teams/add-or-update-project.json b/openapi/ghe-2.17/operations/teams/add-or-update-project.json index 6f31d2f4d3..86c836067d 100644 --- a/openapi/ghe-2.17/operations/teams/add-or-update-project.json +++ b/openapi/ghe-2.17/operations/teams/add-or-update-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { @@ -67,8 +67,8 @@ "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.17/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", + "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.17/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.", "enum": [ "read", "write", diff --git a/openapi/ghe-2.17/operations/teams/add-or-update-repo.json b/openapi/ghe-2.17/operations/teams/add-or-update-repo.json index b8c2affb2a..792e1795c9 100644 --- a/openapi/ghe-2.17/operations/teams/add-or-update-repo.json +++ b/openapi/ghe-2.17/operations/teams/add-or-update-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { @@ -75,8 +75,8 @@ "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", + "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.", "enum": [ "pull", "push", diff --git a/openapi/ghe-2.17/operations/teams/check-manages-repo.json b/openapi/ghe-2.17/operations/teams/check-manages-repo.json index a0c2d96a07..40bb08a30e 100644 --- a/openapi/ghe-2.17/operations/teams/check-manages-repo.json +++ b/openapi/ghe-2.17/operations/teams/check-manages-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/create-discussion-comment.json b/openapi/ghe-2.17/operations/teams/create-discussion-comment.json index b55aadf765..81f0f1aefe 100644 --- a/openapi/ghe-2.17/operations/teams/create-discussion-comment.json +++ b/openapi/ghe-2.17/operations/teams/create-discussion-comment.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -198,8 +198,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/teams/create-discussion.json b/openapi/ghe-2.17/operations/teams/create-discussion.json index 3615a17781..4747b2a87e 100644 --- a/openapi/ghe-2.17/operations/teams/create-discussion.json +++ b/openapi/ghe-2.17/operations/teams/create-discussion.json @@ -22,12 +22,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -204,16 +204,16 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." }, "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", + "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.", "default": false } }, diff --git a/openapi/ghe-2.17/operations/teams/create.json b/openapi/ghe-2.17/operations/teams/create.json index 6b63b71833..ae255a90f6 100644 --- a/openapi/ghe-2.17/operations/teams/create.json +++ b/openapi/ghe-2.17/operations/teams/create.json @@ -21,12 +21,12 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } } ], "responses": { @@ -197,38 +197,38 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "maintainers": { - "description": "The logins of organization members to add as maintainers of the team.", "type": "array", + "description": "The logins of organization members to add as maintainers of the team.", "items": { "type": "string" } }, "repo_names": { - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -237,12 +237,12 @@ "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" + "type": "integer", + "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." }, "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.17/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN.", - "type": "string" + "type": "string", + "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.17/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/teams/delete-discussion-comment.json b/openapi/ghe-2.17/operations/teams/delete-discussion-comment.json index 451d01b872..5b2e3d184c 100644 --- a/openapi/ghe-2.17/operations/teams/delete-discussion-comment.json +++ b/openapi/ghe-2.17/operations/teams/delete-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/delete-discussion.json b/openapi/ghe-2.17/operations/teams/delete-discussion.json index 266ce68c5b..9a76f24fad 100644 --- a/openapi/ghe-2.17/operations/teams/delete-discussion.json +++ b/openapi/ghe-2.17/operations/teams/delete-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/delete.json b/openapi/ghe-2.17/operations/teams/delete.json index 2eed748e67..8c5452a650 100644 --- a/openapi/ghe-2.17/operations/teams/delete.json +++ b/openapi/ghe-2.17/operations/teams/delete.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/get-by-name.json b/openapi/ghe-2.17/operations/teams/get-by-name.json index aa57e4a1b7..44d7a056d5 100644 --- a/openapi/ghe-2.17/operations/teams/get-by-name.json +++ b/openapi/ghe-2.17/operations/teams/get-by-name.json @@ -21,21 +21,21 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "team_slug", + "description": "team_slug parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "team_slug parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/get-discussion-comment.json b/openapi/ghe-2.17/operations/teams/get-discussion-comment.json index f0803ccb03..9f6a8901cd 100644 --- a/openapi/ghe-2.17/operations/teams/get-discussion-comment.json +++ b/openapi/ghe-2.17/operations/teams/get-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/get-discussion.json b/openapi/ghe-2.17/operations/teams/get-discussion.json index 96a47c22df..7a9fb41f78 100644 --- a/openapi/ghe-2.17/operations/teams/get-discussion.json +++ b/openapi/ghe-2.17/operations/teams/get-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/get-member.json b/openapi/ghe-2.17/operations/teams/get-member.json index 38cf0133cf..550effb74b 100644 --- a/openapi/ghe-2.17/operations/teams/get-member.json +++ b/openapi/ghe-2.17/operations/teams/get-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/get-membership.json b/openapi/ghe-2.17/operations/teams/get-membership.json index 944c5aa23c..32235d4baa 100644 --- a/openapi/ghe-2.17/operations/teams/get-membership.json +++ b/openapi/ghe-2.17/operations/teams/get-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/get.json b/openapi/ghe-2.17/operations/teams/get.json index ad277bd6fb..2cd942ec73 100644 --- a/openapi/ghe-2.17/operations/teams/get.json +++ b/openapi/ghe-2.17/operations/teams/get.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-child.json b/openapi/ghe-2.17/operations/teams/list-child.json index 1f24c12e7e..b58a83107b 100644 --- a/openapi/ghe-2.17/operations/teams/list-child.json +++ b/openapi/ghe-2.17/operations/teams/list-child.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-discussion-comments.json b/openapi/ghe-2.17/operations/teams/list-discussion-comments.json index 1044268e0b..d0073717f7 100644 --- a/openapi/ghe-2.17/operations/teams/list-discussion-comments.json +++ b/openapi/ghe-2.17/operations/teams/list-discussion-comments.json @@ -22,25 +22,27 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -48,29 +50,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-discussions.json b/openapi/ghe-2.17/operations/teams/list-discussions.json index f4fe210496..57521896df 100644 --- a/openapi/ghe-2.17/operations/teams/list-discussions.json +++ b/openapi/ghe-2.17/operations/teams/list-discussions.json @@ -22,16 +22,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-for-authenticated-user.json b/openapi/ghe-2.17/operations/teams/list-for-authenticated-user.json index 2879e9dfff..2432754c7d 100644 --- a/openapi/ghe-2.17/operations/teams/list-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/teams/list-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-members.json b/openapi/ghe-2.17/operations/teams/list-members.json index 0d4e0ac594..30867c4c9d 100644 --- a/openapi/ghe-2.17/operations/teams/list-members.json +++ b/openapi/ghe-2.17/operations/teams/list-members.json @@ -21,16 +21,18 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -39,29 +41,25 @@ "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", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-projects.json b/openapi/ghe-2.17/operations/teams/list-projects.json index ca9cf9d41e..c109bd0eea 100644 --- a/openapi/ghe-2.17/operations/teams/list-projects.json +++ b/openapi/ghe-2.17/operations/teams/list-projects.json @@ -22,32 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list-repos.json b/openapi/ghe-2.17/operations/teams/list-repos.json index 469c9c974c..324b8d5403 100644 --- a/openapi/ghe-2.17/operations/teams/list-repos.json +++ b/openapi/ghe-2.17/operations/teams/list-repos.json @@ -21,32 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/list.json b/openapi/ghe-2.17/operations/teams/list.json index 13a6f5f51f..7fa0b01e94 100644 --- a/openapi/ghe-2.17/operations/teams/list.json +++ b/openapi/ghe-2.17/operations/teams/list.json @@ -21,32 +21,30 @@ }, { "name": "org", + "description": "org parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "org parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/remove-member.json b/openapi/ghe-2.17/operations/teams/remove-member.json index a18987f798..bc0bd300c0 100644 --- a/openapi/ghe-2.17/operations/teams/remove-member.json +++ b/openapi/ghe-2.17/operations/teams/remove-member.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/remove-membership.json b/openapi/ghe-2.17/operations/teams/remove-membership.json index e778b98319..f7e03cbecc 100644 --- a/openapi/ghe-2.17/operations/teams/remove-membership.json +++ b/openapi/ghe-2.17/operations/teams/remove-membership.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/remove-project.json b/openapi/ghe-2.17/operations/teams/remove-project.json index 16897b2067..a483b0b3a0 100644 --- a/openapi/ghe-2.17/operations/teams/remove-project.json +++ b/openapi/ghe-2.17/operations/teams/remove-project.json @@ -21,21 +21,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/remove-repo.json b/openapi/ghe-2.17/operations/teams/remove-repo.json index 6841c598d0..48f4803720 100644 --- a/openapi/ghe-2.17/operations/teams/remove-repo.json +++ b/openapi/ghe-2.17/operations/teams/remove-repo.json @@ -21,30 +21,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/review-project.json b/openapi/ghe-2.17/operations/teams/review-project.json index 37a0b65348..01ecc50f64 100644 --- a/openapi/ghe-2.17/operations/teams/review-project.json +++ b/openapi/ghe-2.17/operations/teams/review-project.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "project_id", + "description": "project_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "project_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/teams/update-discussion-comment.json b/openapi/ghe-2.17/operations/teams/update-discussion-comment.json index 150a324bbe..23f2d12489 100644 --- a/openapi/ghe-2.17/operations/teams/update-discussion-comment.json +++ b/openapi/ghe-2.17/operations/teams/update-discussion-comment.json @@ -22,30 +22,30 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } }, { "name": "comment_number", + "description": "comment_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "comment_number parameter" + } } ], "responses": { @@ -206,8 +206,8 @@ "type": "object", "properties": { "body": { - "description": "The discussion comment's body text.", - "type": "string" + "type": "string", + "description": "The discussion comment's body text." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/teams/update-discussion.json b/openapi/ghe-2.17/operations/teams/update-discussion.json index 0b6c48a40b..53ec919012 100644 --- a/openapi/ghe-2.17/operations/teams/update-discussion.json +++ b/openapi/ghe-2.17/operations/teams/update-discussion.json @@ -22,21 +22,21 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } }, { "name": "discussion_number", + "description": "discussion_number parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "discussion_number parameter" + } } ], "responses": { @@ -212,12 +212,12 @@ "type": "object", "properties": { "title": { - "description": "The discussion post's title.", - "type": "string" + "type": "string", + "description": "The discussion post's title." }, "body": { - "description": "The discussion post's body text.", - "type": "string" + "type": "string", + "description": "The discussion post's body text." } } } diff --git a/openapi/ghe-2.17/operations/teams/update.json b/openapi/ghe-2.17/operations/teams/update.json index 17d2e04864..fc64486367 100644 --- a/openapi/ghe-2.17/operations/teams/update.json +++ b/openapi/ghe-2.17/operations/teams/update.json @@ -21,12 +21,12 @@ }, { "name": "team_id", + "description": "team_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "team_id parameter" + } } ], "responses": { @@ -197,24 +197,24 @@ "type": "object", "properties": { "name": { - "description": "The name of the team.", - "type": "string" + "type": "string", + "description": "The name of the team." }, "description": { - "description": "The description of the team.", - "type": "string" + "type": "string", + "description": "The description of the team." }, "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", + "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.", "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", + "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.", "enum": [ "pull", "push", @@ -223,8 +223,8 @@ "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" + "type": "integer", + "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." } }, "required": [ diff --git a/openapi/ghe-2.17/operations/users/add-emails.json b/openapi/ghe-2.17/operations/users/add-emails.json index 28ec696083..87b50eb816 100644 --- a/openapi/ghe-2.17/operations/users/add-emails.json +++ b/openapi/ghe-2.17/operations/users/add-emails.json @@ -72,8 +72,8 @@ "type": "object", "properties": { "emails": { - "description": "Adds one or more email addresses to your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Adds one or more email addresses to your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/users/check-following-for-user.json b/openapi/ghe-2.17/operations/users/check-following-for-user.json index b21023a84d..042f39e3a6 100644 --- a/openapi/ghe-2.17/operations/users/check-following-for-user.json +++ b/openapi/ghe-2.17/operations/users/check-following-for-user.json @@ -21,21 +21,21 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "target_user", + "description": "target_user parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "target_user parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/check-following.json b/openapi/ghe-2.17/operations/users/check-following.json index e6b84b31bb..3333941a64 100644 --- a/openapi/ghe-2.17/operations/users/check-following.json +++ b/openapi/ghe-2.17/operations/users/check-following.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/create-gpg-key.json b/openapi/ghe-2.17/operations/users/create-gpg-key.json index eda7273efd..926502e650 100644 --- a/openapi/ghe-2.17/operations/users/create-gpg-key.json +++ b/openapi/ghe-2.17/operations/users/create-gpg-key.json @@ -147,8 +147,8 @@ "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.17/operations/users/create-public-key.json b/openapi/ghe-2.17/operations/users/create-public-key.json index f89f50b810..d38de2e03e 100644 --- a/openapi/ghe-2.17/operations/users/create-public-key.json +++ b/openapi/ghe-2.17/operations/users/create-public-key.json @@ -78,12 +78,12 @@ "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" + "type": "string", + "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\"." }, "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" + "type": "string", + "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." } } } diff --git a/openapi/ghe-2.17/operations/users/delete-emails.json b/openapi/ghe-2.17/operations/users/delete-emails.json index d520196be9..ec45038857 100644 --- a/openapi/ghe-2.17/operations/users/delete-emails.json +++ b/openapi/ghe-2.17/operations/users/delete-emails.json @@ -48,8 +48,8 @@ "type": "object", "properties": { "emails": { - "description": "Deletes one or more email addresses from your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "type": "array", + "description": "Deletes one or more email addresses from your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", "items": { "type": "string" } diff --git a/openapi/ghe-2.17/operations/users/delete-gpg-key.json b/openapi/ghe-2.17/operations/users/delete-gpg-key.json index a2e06a2c09..d68bda64b5 100644 --- a/openapi/ghe-2.17/operations/users/delete-gpg-key.json +++ b/openapi/ghe-2.17/operations/users/delete-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/delete-public-key.json b/openapi/ghe-2.17/operations/users/delete-public-key.json index 0fecaf9fef..ae529ec677 100644 --- a/openapi/ghe-2.17/operations/users/delete-public-key.json +++ b/openapi/ghe-2.17/operations/users/delete-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/follow.json b/openapi/ghe-2.17/operations/users/follow.json index dd97fc3ea9..b6a6810d9b 100644 --- a/openapi/ghe-2.17/operations/users/follow.json +++ b/openapi/ghe-2.17/operations/users/follow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/get-by-username.json b/openapi/ghe-2.17/operations/users/get-by-username.json index 8016b9b60f..c4bd364d2a 100644 --- a/openapi/ghe-2.17/operations/users/get-by-username.json +++ b/openapi/ghe-2.17/operations/users/get-by-username.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/get-context-for-user.json b/openapi/ghe-2.17/operations/users/get-context-for-user.json index d64ee00955..433965b8f5 100644 --- a/openapi/ghe-2.17/operations/users/get-context-for-user.json +++ b/openapi/ghe-2.17/operations/users/get-context-for-user.json @@ -22,16 +22,18 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "subject_type", + "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`.", "in": "query", + "required": false, "schema": { "type": "string", "enum": [ @@ -40,18 +42,16 @@ "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", + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/get-gpg-key.json b/openapi/ghe-2.17/operations/users/get-gpg-key.json index 14d4bba7a7..fd150b8021 100644 --- a/openapi/ghe-2.17/operations/users/get-gpg-key.json +++ b/openapi/ghe-2.17/operations/users/get-gpg-key.json @@ -21,12 +21,12 @@ }, { "name": "gpg_key_id", + "description": "gpg_key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "gpg_key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/get-public-key.json b/openapi/ghe-2.17/operations/users/get-public-key.json index 72286a8c10..54b7e0a2a9 100644 --- a/openapi/ghe-2.17/operations/users/get-public-key.json +++ b/openapi/ghe-2.17/operations/users/get-public-key.json @@ -21,12 +21,12 @@ }, { "name": "key_id", + "description": "key_id parameter", "in": "path", + "required": true, "schema": { "type": "integer" - }, - "required": true, - "description": "key_id parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-emails.json b/openapi/ghe-2.17/operations/users/list-emails.json index 3801c26a2d..2a57d1914e 100644 --- a/openapi/ghe-2.17/operations/users/list-emails.json +++ b/openapi/ghe-2.17/operations/users/list-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-followers-for-authenticated-user.json b/openapi/ghe-2.17/operations/users/list-followers-for-authenticated-user.json index 0c6a92bb27..e3b541cef5 100644 --- a/openapi/ghe-2.17/operations/users/list-followers-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/users/list-followers-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-followers-for-user.json b/openapi/ghe-2.17/operations/users/list-followers-for-user.json index 8ffbd792aa..c66ac61de6 100644 --- a/openapi/ghe-2.17/operations/users/list-followers-for-user.json +++ b/openapi/ghe-2.17/operations/users/list-followers-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-following-for-authenticated-user.json b/openapi/ghe-2.17/operations/users/list-following-for-authenticated-user.json index e00505c5d4..fc0745f45b 100644 --- a/openapi/ghe-2.17/operations/users/list-following-for-authenticated-user.json +++ b/openapi/ghe-2.17/operations/users/list-following-for-authenticated-user.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-following-for-user.json b/openapi/ghe-2.17/operations/users/list-following-for-user.json index ae78e333e4..f489fe9f9f 100644 --- a/openapi/ghe-2.17/operations/users/list-following-for-user.json +++ b/openapi/ghe-2.17/operations/users/list-following-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-gpg-keys-for-user.json b/openapi/ghe-2.17/operations/users/list-gpg-keys-for-user.json index 7cbf10337d..16d62a8d58 100644 --- a/openapi/ghe-2.17/operations/users/list-gpg-keys-for-user.json +++ b/openapi/ghe-2.17/operations/users/list-gpg-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-gpg-keys.json b/openapi/ghe-2.17/operations/users/list-gpg-keys.json index 038e1cbeac..85db5359e4 100644 --- a/openapi/ghe-2.17/operations/users/list-gpg-keys.json +++ b/openapi/ghe-2.17/operations/users/list-gpg-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-public-emails.json b/openapi/ghe-2.17/operations/users/list-public-emails.json index 6e65de3bbd..5cebf74309 100644 --- a/openapi/ghe-2.17/operations/users/list-public-emails.json +++ b/openapi/ghe-2.17/operations/users/list-public-emails.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-public-keys-for-user.json b/openapi/ghe-2.17/operations/users/list-public-keys-for-user.json index 7c431e29ea..ee10816472 100644 --- a/openapi/ghe-2.17/operations/users/list-public-keys-for-user.json +++ b/openapi/ghe-2.17/operations/users/list-public-keys-for-user.json @@ -21,32 +21,30 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list-public-keys.json b/openapi/ghe-2.17/operations/users/list-public-keys.json index 93ef758fce..71071f5f1c 100644 --- a/openapi/ghe-2.17/operations/users/list-public-keys.json +++ b/openapi/ghe-2.17/operations/users/list-public-keys.json @@ -21,23 +21,21 @@ }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/list.json b/openapi/ghe-2.17/operations/users/list.json index e31dbc6076..32fca5647e 100644 --- a/openapi/ghe-2.17/operations/users/list.json +++ b/openapi/ghe-2.17/operations/users/list.json @@ -21,32 +21,30 @@ }, { "name": "since", + "description": "The integer ID of the last User that you've seen.", "in": "query", + "required": false, "schema": { "type": "string" - }, - "required": false, - "description": "The integer ID of the last User that you've seen." + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/unfollow.json b/openapi/ghe-2.17/operations/users/unfollow.json index 956d1bfa93..35d6ec1d85 100644 --- a/openapi/ghe-2.17/operations/users/unfollow.json +++ b/openapi/ghe-2.17/operations/users/unfollow.json @@ -21,12 +21,12 @@ }, { "name": "username", + "description": "username parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "username parameter" + } } ], "responses": { diff --git a/openapi/ghe-2.17/operations/users/update-authenticated.json b/openapi/ghe-2.17/operations/users/update-authenticated.json index 03b61acd36..4dc51e2f1c 100644 --- a/openapi/ghe-2.17/operations/users/update-authenticated.json +++ b/openapi/ghe-2.17/operations/users/update-authenticated.json @@ -188,32 +188,32 @@ "type": "object", "properties": { "name": { - "description": "The new name of the user.", - "type": "string" + "type": "string", + "description": "The new name of the user." }, "email": { - "description": "The publicly visible email address of the user.", - "type": "string" + "type": "string", + "description": "The publicly visible email address of the user." }, "blog": { - "description": "The new blog URL of the user.", - "type": "string" + "type": "string", + "description": "The new blog URL of the user." }, "company": { - "description": "The new company of the user.", - "type": "string" + "type": "string", + "description": "The new company of the user." }, "location": { - "description": "The new location of the user.", - "type": "string" + "type": "string", + "description": "The new location of the user." }, "hireable": { - "description": "The new hiring availability of the user.", - "type": "boolean" + "type": "boolean", + "description": "The new hiring availability of the user." }, "bio": { - "description": "The new short biography of the user.", - "type": "string" + "type": "string", + "description": "The new short biography of the user." } } } From 7bc82910c857f2a225420f1d14104ef5e05ac761 Mon Sep 17 00:00:00 2001 From: Derek Date: Wed, 14 Aug 2019 23:14:40 +0200 Subject: [PATCH 3/3] fix: update overridden operations --- .../v3/git/refs/get-a-reference.json | 62 +++++++++--- .../v3/git/refs/get-all-references.json | 87 ++++++++++------- .../overrides/v3/git/trees/get-a-tree.json | 95 +++++++++++++------ .../releases/upload-a-release-asset.json | 76 +++++++-------- .../operations/git/get-ref.json | 60 +++++++++--- .../operations/git/get-tree.json | 71 +++++++++++--- openapi/ghe-2.15/operations/git/get-ref.json | 60 +++++++++--- openapi/ghe-2.15/operations/git/get-tree.json | 71 +++++++++++--- openapi/ghe-2.16/operations/git/get-ref.json | 60 +++++++++--- openapi/ghe-2.16/operations/git/get-tree.json | 71 +++++++++++--- openapi/ghe-2.17/operations/git/get-ref.json | 60 +++++++++--- openapi/ghe-2.17/operations/git/get-tree.json | 71 +++++++++++--- test/integration/endpoints-test.js | 1 - 13 files changed, 613 insertions(+), 232 deletions(-) diff --git a/lib/endpoint/overrides/v3/git/refs/get-a-reference.json b/lib/endpoint/overrides/v3/git/refs/get-a-reference.json index 74f69f77f3..49714aa8e1 100644 --- a/lib/endpoint/overrides/v3/git/refs/get-a-reference.json +++ b/lib/endpoint/overrides/v3/git/refs/get-a-reference.json @@ -1,11 +1,11 @@ [ { + "method": "GET", "path": "/repos/:owner/:repo/git/refs/:ref", - "method": "get", "operation": { "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", + "operationId": "git/get-ref", "tags": [ "git" ], @@ -25,45 +25,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "Must be formatted as `heads/branch`, not just `branch`", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "Must be formatted as `heads/branch`, not just `branch`" + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/refs/REF" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + "source": "octokit.git.getRef({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" } ], "x-github": { diff --git a/lib/endpoint/overrides/v3/git/refs/get-all-references.json b/lib/endpoint/overrides/v3/git/refs/get-all-references.json index da3e9175cb..2a50798b3a 100644 --- a/lib/endpoint/overrides/v3/git/refs/get-all-references.json +++ b/lib/endpoint/overrides/v3/git/refs/get-all-references.json @@ -1,11 +1,11 @@ [ { + "method": "GET", "path": "/repos/:owner/:repo/git/refs/:namespace", - "method": "get", "operation": { "summary": "Get all references", - "description": "This will return an array of all the references on the system, including things like notes and stashes if they exist on the server.", - "operationId": "git-list-refs", + "description": "Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a merge commit creation. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\n```\nGET /repos/octocat/Hello-World/git/refs\n```\n\nYou can also request a sub-namespace. For example, to get all the tag references, you can call:\n\n```\nGET /repos/octocat/Hello-World/git/refs/tags\n```", + "operationId": "git/get-refs", "tags": [ "git" ], @@ -25,74 +25,89 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", - "schema": { - "type": "string" - }, "required": true, - "description": "owner parameter" - }, - { - "name": "repo", - "in": "path", "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { - "name": "ref", + "name": "repo", + "description": "repo parameter", "in": "path", - "schema": { - "type": "string" - }, "required": true, - "description": "Must be formatted as `heads/branch`, not just `branch`" - }, - { - "name": "namespace", - "in": "path", "schema": { "type": "string" - }, - "required": false, - "description": "Filter by sub-namespace (reference prefix). Most commen examples would be `'heads/'` and `'tags/'` to retrieve branches or tags" + } }, { "name": "per_page", + "description": "Results per page (max 100)", "in": "query", "schema": { "type": "integer", "default": 30 - }, - "required": false, - "description": "Results per page (max 100)" + } }, { "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", "default": 1 - }, - "required": false, - "description": "Page number of the results to fetch." + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "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 -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:namespace" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/refs" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n namespace: 'namespace'\n})" + "source": "octokit.git.getRefs({\n owner: 'octocat',\n repo: 'hello-world'\n})" } ], "x-github": { diff --git a/lib/endpoint/overrides/v3/git/trees/get-a-tree.json b/lib/endpoint/overrides/v3/git/trees/get-a-tree.json index 00f3af116b..6db1fd3e13 100644 --- a/lib/endpoint/overrides/v3/git/trees/get-a-tree.json +++ b/lib/endpoint/overrides/v3/git/trees/get-a-tree.json @@ -1,11 +1,11 @@ [ { + "method": "GET", "path": "/repos/:owner/:repo/git/trees/:tree_sha", - "method": "get", "operation": { "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", + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "operationId": "git/get-tree", "tags": [ "git" ], @@ -25,56 +25,97 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "tree_sha", + "description": "tree_sha parameter", "in": "path", - "schema": { - "type": "string" - }, "required": true, - "description": "tree_sha parameter" - }, - { - "name": "recursive", - "in": "query", "schema": { - "type": "integer", - "enum": [ - 1 - ] - }, - "description": "recursive parameter" + "type": "string" + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "content": { + "application/json": { + "schema": { + "type": "object", + "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" + } + }, + "required": [ + "path", + "mode", + "type", + "sha", + "url", + "size" + ] + } + }, + "truncated": { + "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/git/trees/:tree_sha" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/trees/TREE_SHA" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" + "source": "octokit.git.getTree({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" } ], "x-github": { diff --git a/lib/endpoint/overrides/v3/repos/releases/upload-a-release-asset.json b/lib/endpoint/overrides/v3/repos/releases/upload-a-release-asset.json index fbab6005a4..bcbf3c5ee1 100644 --- a/lib/endpoint/overrides/v3/repos/releases/upload-a-release-asset.json +++ b/lib/endpoint/overrides/v3/repos/releases/upload-a-release-asset.json @@ -1,11 +1,11 @@ [ { - "method": "post", + "method": "POST", "path": ":url", "operation": { "summary": "Upload a release asset", - "description": "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. This endpoint is provided by a URI template in [the release's API response](https://developer.github.com/v3/repos/releases/#get-a-single-release). You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nThe asset data is expected in its raw binary form, rather than JSON. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.\n\nSend the raw binary content of the asset as the request body.\n\nThis may leave an empty asset with a state of `\"new\"`. It can be safely deleted.", - "operationId": "repos-upload-release-asset", + "description": "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:\n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.\n\n**Notes:**\n\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release)\" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://github.com/contact).\n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.\n\nThis may leave an empty asset with a state of `starter`. It can be safely deleted.", + "operationId": "repos/upload-release-asset", "tags": [ "repos" ], @@ -24,49 +24,40 @@ } }, { - "name": "url", + "name": "server", + "description": "server parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "url parameter" + } }, { - "name": "content-length", - "in": "header", - "schema": { - "type": "integer" - }, + "name": "owner", + "description": "owner parameter", + "in": "path", "required": true, - "description": "The content size of the asset in bytes" - }, - { - "name": "content-type", - "in": "header", "schema": { "type": "string" - }, - "required": true, - "description": "The content type of the asset. This should be set in the Header. Example: `\"application/zip\"`. For a list of acceptable types, refer this list of [media types](https://www.iana.org/assignments/media-types/media-types.xhtml)." + } }, { - "name": "name", - "in": "query", + "name": "repo", + "description": "repo parameter", + "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "The file name of the asset. This should be set in a URI query parameter." + } }, { - "name": "label", - "in": "query", + "name": "release_id", + "description": "release_id parameter", + "in": "path", + "required": true, "schema": { - "type": "string" - }, - "required": false, - "description": "An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter." + "type": "integer" + } } ], "responses": { @@ -77,26 +68,37 @@ "x-code-samples": [ { "lang": "Shell", - "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n :url" + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/v3/SERVER/repos/octocat/hello-world/releases/42/assets \\\n -d '{\"name\":\"name\"}'" }, { "lang": "JS", - "source": "octokit.repos.get({\n url: 'url',\n name: 'name',\n file: 'file'\n})" + "source": "octokit.repos.uploadReleaseAsset({\n server: 'server',\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 42,\n name: 'name'\n})" } ], "x-github": { "legacy": false, "enabledForApps": true, - "githubCloudOnly": false, - "requestBodyParameterName": "file" + "githubCloudOnly": false }, "x-changes": [], "requestBody": { "content": { "application/json": { "schema": { - "type": "string", - "description": "file parameter" + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The file name of the asset. This should be set in a URI query parameter." + }, + "label": { + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter." + } + }, + "required": [ + "name" + ] } } } diff --git a/openapi/api.github.com/operations/git/get-ref.json b/openapi/api.github.com/operations/git/get-ref.json index aa726a413b..95e49f7546 100644 --- a/openapi/api.github.com/operations/git/get-ref.json +++ b/openapi/api.github.com/operations/git/get-ref.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-ref", "tags": [ "git" ], @@ -21,45 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "Must be formatted as `heads/branch`, not just `branch`", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "Must be formatted as `heads/branch`, not just `branch`" + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/refs/REF" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + "source": "octokit.git.getRef({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" } ], "x-github": { diff --git a/openapi/api.github.com/operations/git/get-tree.json b/openapi/api.github.com/operations/git/get-tree.json index bc6a503566..d91e6e9e94 100644 --- a/openapi/api.github.com/operations/git/get-tree.json +++ b/openapi/api.github.com/operations/git/get-tree.json @@ -1,6 +1,6 @@ { "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.", + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", "operationId": "git/get-tree", "tags": [ "git" @@ -45,28 +45,69 @@ "schema": { "type": "string" } - }, - { - "name": "recursive", - "description": "recursive parameter", - "in": "query", - "schema": { - "type": "integer", - "enum": [ - 1 - ] - } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "content": { + "application/json": { + "schema": { + "type": "object", + "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" + } + }, + "required": [ + "path", + "mode", + "type", + "sha", + "url", + "size" + ] + } + }, + "truncated": { + "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/git/trees/:tree_sha" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/trees/TREE_SHA" }, { "lang": "JS", diff --git a/openapi/ghe-2.15/operations/git/get-ref.json b/openapi/ghe-2.15/operations/git/get-ref.json index 78c37f161b..94512922bc 100644 --- a/openapi/ghe-2.15/operations/git/get-ref.json +++ b/openapi/ghe-2.15/operations/git/get-ref.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-ref", "tags": [ "git" ], @@ -21,45 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "Must be formatted as `heads/branch`, not just `branch`", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "Must be formatted as `heads/branch`, not just `branch`" + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/refs/REF" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + "source": "octokit.git.getRef({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" } ], "x-github": { diff --git a/openapi/ghe-2.15/operations/git/get-tree.json b/openapi/ghe-2.15/operations/git/get-tree.json index 3d2d11b807..4e0f490e26 100644 --- a/openapi/ghe-2.15/operations/git/get-tree.json +++ b/openapi/ghe-2.15/operations/git/get-tree.json @@ -1,6 +1,6 @@ { "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.", + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", "operationId": "git/get-tree", "tags": [ "git" @@ -45,28 +45,69 @@ "schema": { "type": "string" } - }, - { - "name": "recursive", - "description": "recursive parameter", - "in": "query", - "schema": { - "type": "integer", - "enum": [ - 1 - ] - } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "content": { + "application/json": { + "schema": { + "type": "object", + "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" + } + }, + "required": [ + "path", + "mode", + "type", + "sha", + "url", + "size" + ] + } + }, + "truncated": { + "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/git/trees/:tree_sha" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/trees/TREE_SHA" }, { "lang": "JS", diff --git a/openapi/ghe-2.16/operations/git/get-ref.json b/openapi/ghe-2.16/operations/git/get-ref.json index b0f0189377..c952a73ef3 100644 --- a/openapi/ghe-2.16/operations/git/get-ref.json +++ b/openapi/ghe-2.16/operations/git/get-ref.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-ref", "tags": [ "git" ], @@ -21,45 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "Must be formatted as `heads/branch`, not just `branch`", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "Must be formatted as `heads/branch`, not just `branch`" + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/refs/REF" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + "source": "octokit.git.getRef({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" } ], "x-github": { diff --git a/openapi/ghe-2.16/operations/git/get-tree.json b/openapi/ghe-2.16/operations/git/get-tree.json index ef92f56f01..7532fe5b67 100644 --- a/openapi/ghe-2.16/operations/git/get-tree.json +++ b/openapi/ghe-2.16/operations/git/get-tree.json @@ -1,6 +1,6 @@ { "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.", + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", "operationId": "git/get-tree", "tags": [ "git" @@ -45,28 +45,69 @@ "schema": { "type": "string" } - }, - { - "name": "recursive", - "description": "recursive parameter", - "in": "query", - "schema": { - "type": "integer", - "enum": [ - 1 - ] - } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "content": { + "application/json": { + "schema": { + "type": "object", + "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" + } + }, + "required": [ + "path", + "mode", + "type", + "sha", + "url", + "size" + ] + } + }, + "truncated": { + "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/git/trees/:tree_sha" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/trees/TREE_SHA" }, { "lang": "JS", diff --git a/openapi/ghe-2.17/operations/git/get-ref.json b/openapi/ghe-2.17/operations/git/get-ref.json index 18d5ea4216..3a4ffcbf3b 100644 --- a/openapi/ghe-2.17/operations/git/get-ref.json +++ b/openapi/ghe-2.17/operations/git/get-ref.json @@ -1,7 +1,7 @@ { "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", + "operationId": "git/get-ref", "tags": [ "git" ], @@ -21,45 +21,77 @@ }, { "name": "owner", + "description": "owner parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "owner parameter" + } }, { "name": "repo", + "description": "repo parameter", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "repo parameter" + } }, { "name": "ref", + "description": "Must be formatted as `heads/branch`, not just `branch`", "in": "path", + "required": true, "schema": { "type": "string" - }, - "required": true, - "description": "Must be formatted as `heads/branch`, not just `branch`" + } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "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 -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/refs/REF" }, { "lang": "JS", - "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + "source": "octokit.git.getRef({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" } ], "x-github": { diff --git a/openapi/ghe-2.17/operations/git/get-tree.json b/openapi/ghe-2.17/operations/git/get-tree.json index 2eb2387d03..f1c4f2291b 100644 --- a/openapi/ghe-2.17/operations/git/get-tree.json +++ b/openapi/ghe-2.17/operations/git/get-tree.json @@ -1,6 +1,6 @@ { "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.", + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", "operationId": "git/get-tree", "tags": [ "git" @@ -45,28 +45,69 @@ "schema": { "type": "string" } - }, - { - "name": "recursive", - "description": "recursive parameter", - "in": "query", - "schema": { - "type": "integer", - "enum": [ - 1 - ] - } } ], "responses": { - "418": { - "description": "Response definition missing" + "200": { + "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "content": { + "application/json": { + "schema": { + "type": "object", + "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" + } + }, + "required": [ + "path", + "mode", + "type", + "sha", + "url", + "size" + ] + } + }, + "truncated": { + "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/git/trees/:tree_sha" + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/hello-world/git/trees/TREE_SHA" }, { "lang": "JS", diff --git a/test/integration/endpoints-test.js b/test/integration/endpoints-test.js index 3fd5c018f4..c283671428 100644 --- a/test/integration/endpoints-test.js +++ b/test/integration/endpoints-test.js @@ -32,7 +32,6 @@ async function testEndpoints (urls) { }) } -// TODO: Remove sorting (after openapi docs are regenerated by legacy-less algo) function sortByPathThenMethod (a, b) { switch (true) { case a.path < b.path: